bgpd/bgpd.h

   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 "lib/json.h"
  28 #include "vrf.h"
  29 #include "vty.h"
  30
  31 /* For union sockunion.  */
  32 #include "queue.h"
  33 #include "sockunion.h"
  34 #include "routemap.h"
  35 #include "linklist.h"
  36 #include "defaults.h"
  37 #include "bgp_memory.h"
  38 #include "bitfield.h"
  39 #include "vxlan.h"
  40 #include "bgp_labelpool.h"
  41
  42 #define BGP_MAX_HOSTNAME 64     /* Linux max, is larger than most other sys */
  43 #define BGP_PEER_MAX_HASH_SIZE 16384
  44
  45 /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
  46 #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
  47
  48 struct update_subgroup;
  49 struct bpacket;
  50 struct bgp_pbr_config;
  51
  52 /*
  53  * Allow the neighbor XXXX remote-as to take internal or external
  54  * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
  55  * behavior
  56  * in the system.
  57  */
  58 enum { AS_UNSPECIFIED = 0,
  59        AS_SPECIFIED,
  60        AS_INTERNAL,
  61        AS_EXTERNAL,
  62 };
  63
  64 /* Typedef BGP specific types.  */
  65 typedef uint32_t as_t;
  66 typedef uint16_t as16_t; /* we may still encounter 16 Bit asnums */
  67 typedef uint16_t bgp_size_t;
  68
  69 #define max(a, b)                                                              \
  70         ({                                                                     \
  71                 __typeof__(a) _a = (a);                                        \
  72                 __typeof__(b) _b = (b);                                        \
  73                 _a > _b ? _a : _b;                                             \
  74         })
  75
  76 enum bgp_af_index {
  77         BGP_AF_START,
  78         BGP_AF_IPV4_UNICAST = BGP_AF_START,
  79         BGP_AF_IPV4_MULTICAST,
  80         BGP_AF_IPV4_VPN,
  81         BGP_AF_IPV6_UNICAST,
  82         BGP_AF_IPV6_MULTICAST,
  83         BGP_AF_IPV6_VPN,
  84         BGP_AF_IPV4_ENCAP,
  85         BGP_AF_IPV6_ENCAP,
  86         BGP_AF_L2VPN_EVPN,
  87         BGP_AF_IPV4_LBL_UNICAST,
  88         BGP_AF_IPV6_LBL_UNICAST,
  89         BGP_AF_IPV4_FLOWSPEC,
  90         BGP_AF_IPV6_FLOWSPEC,
  91         BGP_AF_MAX
  92 };
  93
  94 #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
  95
  96 #define FOREACH_AFI_SAFI(afi, safi)                                            \
  97         for (afi = AFI_IP; afi < AFI_MAX; afi++)                               \
  98                 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
  99
 100 #define FOREACH_SAFI(safi)                                            \
 101         for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
 102
 103 /* BGP master for system wide configurations and variables.  */
 104 struct bgp_master {
 105         /* BGP instance list.  */
 106         struct list *bgp;
 107
 108         /* BGP thread master.  */
 109         struct thread_master *master;
 110
 111 /* BGP pthreads. */
 112 #define PTHREAD_IO              (1 << 1)
 113 #define PTHREAD_KEEPALIVES      (1 << 2)
 114
 115         /* work queues */
 116         struct work_queue *process_main_queue;
 117
 118         /* Listening sockets */
 119         struct list *listen_sockets;
 120
 121         /* BGP port number.  */
 122         uint16_t port;
 123
 124         /* Listener address */
 125         char *address;
 126
 127         /* BGP start time.  */
 128         time_t start_time;
 129
 130         /* Various BGP global configuration.  */
 131         uint8_t options;
 132 #define BGP_OPT_NO_FIB                   (1 << 0)
 133 #define BGP_OPT_MULTIPLE_INSTANCE        (1 << 1)
 134 #define BGP_OPT_CONFIG_CISCO             (1 << 2)
 135 #define BGP_OPT_NO_LISTEN                (1 << 3)
 136
 137         uint64_t updgrp_idspace;
 138         uint64_t subgrp_idspace;
 139
 140         /* timer to dampen route map changes */
 141         struct thread *t_rmap_update; /* Handle route map updates */
 142         uint32_t rmap_update_timer;   /* Route map update timer */
 143 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
 144
 145         /* Id space for automatic RD derivation for an EVI/VRF */
 146         bitfield_t rd_idspace;
 147
 148         /* dynamic mpls label allocation pool */
 149         struct labelpool labelpool;
 150
 151         bool terminating;       /* global flag that sigint terminate seen */
 152         QOBJ_FIELDS
 153 };
 154 DECLARE_QOBJ_TYPE(bgp_master)
 155
 156 /* BGP route-map structure.  */
 157 struct bgp_rmap {
 158         char *name;
 159         struct route_map *map;
 160 };
 161
 162 struct bgp_redist {
 163         unsigned short instance;
 164
 165         /* BGP redistribute metric configuration. */
 166         uint8_t redist_metric_flag;
 167         uint32_t redist_metric;
 168
 169         /* BGP redistribute route-map.  */
 170         struct bgp_rmap rmap;
 171 };
 172
 173 typedef enum {
 174         BGP_VPN_POLICY_DIR_FROMVPN = 0,
 175         BGP_VPN_POLICY_DIR_TOVPN = 1,
 176         BGP_VPN_POLICY_DIR_MAX = 2
 177 } vpn_policy_direction_t;
 178
 179 struct vpn_policy {
 180         struct bgp *bgp; /* parent */
 181         afi_t afi;
 182         struct ecommunity *rtlist[BGP_VPN_POLICY_DIR_MAX];
 183         struct ecommunity *import_redirect_rtlist;
 184         char *rmap_name[BGP_VPN_POLICY_DIR_MAX];
 185         struct route_map *rmap[BGP_VPN_POLICY_DIR_MAX];
 186
 187         /* should be mpls_label_t? */
 188         uint32_t tovpn_label; /* may be MPLS_LABEL_NONE */
 189         uint32_t tovpn_zebra_vrf_label_last_sent;
 190         struct prefix_rd tovpn_rd;
 191         struct prefix tovpn_nexthop; /* unset => set to 0 */
 192         uint32_t flags;
 193 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO        (1 << 0)
 194 #define BGP_VPN_POLICY_TOVPN_RD_SET            (1 << 1)
 195 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET       (1 << 2)
 196
 197         /*
 198          * If we are importing another vrf into us keep a list of
 199          * vrf names that are being imported into us.
 200          */
 201         struct list *import_vrf;
 202
 203         /*
 204          * if we are being exported to another vrf keep a list of
 205          * vrf names that we are being exported to.
 206          */
 207         struct list *export_vrf;
 208 };
 209
 210 /*
 211  * Type of 'struct bgp'.
 212  * - Default: The default instance
 213  * - VRF: A specific (non-default) VRF
 214  * - View: An instance used for route exchange
 215  * The "default" instance is treated separately to simplify the code. Note
 216  * that if deployed in a Multi-VRF environment, it may not exist.
 217  */
 218 enum bgp_instance_type {
 219         BGP_INSTANCE_TYPE_DEFAULT,
 220         BGP_INSTANCE_TYPE_VRF,
 221         BGP_INSTANCE_TYPE_VIEW
 222 };
 223
 224 /* BGP instance structure.  */
 225 struct bgp {
 226         /* AS number of this BGP instance.  */
 227         as_t as;
 228
 229         /* Name of this BGP instance.  */
 230         char *name;
 231         char *name_pretty;      /* printable "VRF|VIEW name|default" */
 232
 233         /* Type of instance and VRF id. */
 234         enum bgp_instance_type inst_type;
 235         vrf_id_t vrf_id;
 236
 237         /* Reference count to allow peer_delete to finish after bgp_delete */
 238         int lock;
 239
 240         /* Self peer.  */
 241         struct peer *peer_self;
 242
 243         /* BGP peer. */
 244         struct list *peer;
 245         struct hash *peerhash;
 246
 247         /* BGP peer group.  */
 248         struct list *group;
 249
 250         /* The maximum number of BGP dynamic neighbors that can be created */
 251         int dynamic_neighbors_limit;
 252
 253         /* The current number of BGP dynamic neighbors */
 254         int dynamic_neighbors_count;
 255
 256         struct hash *update_groups[BGP_AF_MAX];
 257
 258         /*
 259          * Global statistics for update groups.
 260          */
 261         struct {
 262                 uint32_t join_events;
 263                 uint32_t prune_events;
 264                 uint32_t merge_events;
 265                 uint32_t split_events;
 266                 uint32_t updgrp_switch_events;
 267                 uint32_t peer_refreshes_combined;
 268                 uint32_t adj_count;
 269                 uint32_t merge_checks_triggered;
 270
 271                 uint32_t updgrps_created;
 272                 uint32_t updgrps_deleted;
 273                 uint32_t subgrps_created;
 274                 uint32_t subgrps_deleted;
 275         } update_group_stats;
 276
 277         /* BGP configuration.  */
 278         uint16_t config;
 279 #define BGP_CONFIG_CLUSTER_ID             (1 << 0)
 280 #define BGP_CONFIG_CONFEDERATION          (1 << 1)
 281
 282         /* BGP router identifier.  */
 283         struct in_addr router_id;
 284         struct in_addr router_id_static;
 285         struct in_addr router_id_zebra;
 286
 287         /* BGP route reflector cluster ID.  */
 288         struct in_addr cluster_id;
 289
 290         /* BGP confederation information.  */
 291         as_t confed_id;
 292         as_t *confed_peers;
 293         int confed_peers_cnt;
 294
 295         struct thread
 296                 *t_startup; /* start-up timer on only once at the beginning */
 297
 298         uint32_t v_maxmed_onstartup; /* Duration of max-med on start-up */
 299 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED  0 /* 0 means off, its the default */
 300         uint32_t maxmed_onstartup_value;     /* Max-med value when active on
 301                                                  start-up */
 302         struct thread
 303                 *t_maxmed_onstartup; /* non-null when max-med onstartup is on */
 304         uint8_t maxmed_onstartup_over; /* Flag to make it effective only once */
 305
 306         uint8_t v_maxmed_admin; /* 1/0 if max-med administrative is on/off */
 307 #define BGP_MAXMED_ADMIN_UNCONFIGURED  0 /* Off by default */
 308         uint32_t maxmed_admin_value; /* Max-med value when administrative in on
 309                                       */
 310 #define BGP_MAXMED_VALUE_DEFAULT  4294967294 /* Maximum by default */
 311
 312         uint8_t maxmed_active; /* 1/0 if max-med is active or not */
 313         uint32_t maxmed_value; /* Max-med value when its active */
 314
 315         /* BGP update delay on startup */
 316         struct thread *t_update_delay;
 317         struct thread *t_establish_wait;
 318         uint8_t update_delay_over;
 319         uint8_t main_zebra_update_hold;
 320         uint8_t main_peers_update_hold;
 321         uint16_t v_update_delay;
 322         uint16_t v_establish_wait;
 323         char update_delay_begin_time[64];
 324         char update_delay_end_time[64];
 325         char update_delay_zebra_resume_time[64];
 326         char update_delay_peers_resume_time[64];
 327         uint32_t established;
 328         uint32_t restarted_peers;
 329         uint32_t implicit_eors;
 330         uint32_t explicit_eors;
 331 #define BGP_UPDATE_DELAY_DEF              0
 332 #define BGP_UPDATE_DELAY_MIN              0
 333 #define BGP_UPDATE_DELAY_MAX              3600
 334
 335         /* BGP flags. */
 336         uint32_t flags;
 337 #define BGP_FLAG_ALWAYS_COMPARE_MED       (1 << 0)
 338 #define BGP_FLAG_DETERMINISTIC_MED        (1 << 1)
 339 #define BGP_FLAG_MED_MISSING_AS_WORST     (1 << 2)
 340 #define BGP_FLAG_MED_CONFED               (1 << 3)
 341 #define BGP_FLAG_NO_DEFAULT_IPV4          (1 << 4)
 342 #define BGP_FLAG_NO_CLIENT_TO_CLIENT      (1 << 5)
 343 #define BGP_FLAG_ENFORCE_FIRST_AS         (1 << 6)
 344 #define BGP_FLAG_COMPARE_ROUTER_ID        (1 << 7)
 345 #define BGP_FLAG_ASPATH_IGNORE            (1 << 8)
 346 #define BGP_FLAG_IMPORT_CHECK             (1 << 9)
 347 #define BGP_FLAG_NO_FAST_EXT_FAILOVER     (1 << 10)
 348 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES     (1 << 11)
 349 #define BGP_FLAG_GRACEFUL_RESTART         (1 << 12)
 350 #define BGP_FLAG_ASPATH_CONFED            (1 << 13)
 351 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX   (1 << 14)
 352 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 15)
 353 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1 << 16)
 354 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET   (1 << 17)
 355 #define BGP_FLAG_FORCE_STATIC_PROCESS     (1 << 18)
 356 #define BGP_FLAG_SHOW_HOSTNAME            (1 << 19)
 357 #define BGP_FLAG_GR_PRESERVE_FWD          (1 << 20)
 358 #define BGP_FLAG_GRACEFUL_SHUTDOWN        (1 << 21)
 359
 360         /* BGP Per AF flags */
 361         uint16_t af_flags[AFI_MAX][SAFI_MAX];
 362 #define BGP_CONFIG_DAMPENING                            (1 << 0)
 363 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
 364 #define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST           (1 << 1)
 365 #define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST           (1 << 2)
 366 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4           (1 << 3)
 367 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6           (1 << 4)
 368 /* import/export between address families */
 369 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT                (1 << 5)
 370 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT                (1 << 6)
 371 /* vrf-route leaking flags */
 372 #define BGP_CONFIG_VRF_TO_VRF_IMPORT                    (1 << 7)
 373 #define BGP_CONFIG_VRF_TO_VRF_EXPORT                    (1 << 8)
 374 #define BGP_DEFAULT_NAME                "default"
 375
 376         /* Route table for next-hop lookup cache. */
 377         struct bgp_table *nexthop_cache_table[AFI_MAX];
 378
 379         /* Route table for import-check */
 380         struct bgp_table *import_check_table[AFI_MAX];
 381
 382         struct bgp_table *connected_table[AFI_MAX];
 383
 384         struct hash *address_hash;
 385
 386         /* DB for all local tunnel-ips - used mainly for martian checks
 387            Currently it only has all VxLan tunnel IPs*/
 388         struct hash *tip_hash;
 389
 390         /* Static route configuration.  */
 391         struct bgp_table *route[AFI_MAX][SAFI_MAX];
 392
 393         /* Aggregate address configuration.  */
 394         struct bgp_table *aggregate[AFI_MAX][SAFI_MAX];
 395
 396         /* BGP routing information base.  */
 397         struct bgp_table *rib[AFI_MAX][SAFI_MAX];
 398
 399         /* BGP table route-map.  */
 400         struct bgp_rmap table_map[AFI_MAX][SAFI_MAX];
 401
 402         /* BGP redistribute configuration. */
 403         struct list *redist[AFI_MAX][ZEBRA_ROUTE_MAX];
 404
 405         /* Allocate MPLS labels */
 406         uint8_t allocate_mpls_labels[AFI_MAX][SAFI_MAX];
 407
 408         /* Allocate hash entries to store policy routing information
 409          * The hash are used to host pbr rules somewhere.
 410          * Actually, pbr will only be used by flowspec
 411          * those hash elements will have relationship together as
 412          * illustrated in below diagram:
 413          *
 414          *  pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
 415          *              <----- pbr_match j <--- pbr_match_entry 1..m
 416          *
 417          * - here in BGP structure, the list of match and actions will
 418          * stand for the list of ipset sets, and table_ids in the kernel
 419          * - the arrow above between pbr_match and pbr_action indicate
 420          * that a backpointer permits match to find the action
 421          * - the arrow betwen match_entry and match is a hash list
 422          * contained in match, that lists the whole set of entries
 423          */
 424         struct hash *pbr_match_hash;
 425         struct hash *pbr_action_hash;
 426
 427         /* timer to re-evaluate neighbor default-originate route-maps */
 428         struct thread *t_rmap_def_originate_eval;
 429 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
 430
 431         /* BGP distance configuration.  */
 432         uint8_t distance_ebgp[AFI_MAX][SAFI_MAX];
 433         uint8_t distance_ibgp[AFI_MAX][SAFI_MAX];
 434         uint8_t distance_local[AFI_MAX][SAFI_MAX];
 435
 436         /* BGP default local-preference.  */
 437         uint32_t default_local_pref;
 438
 439         /* BGP default subgroup pkt queue max  */
 440         uint32_t default_subgroup_pkt_queue_max;
 441
 442         /* BGP default timer.  */
 443         uint32_t default_holdtime;
 444         uint32_t default_keepalive;
 445
 446         /* BGP graceful restart */
 447         uint32_t restart_time;
 448         uint32_t stalepath_time;
 449
 450         /* Maximum-paths configuration */
 451         struct bgp_maxpaths_cfg {
 452                 uint16_t maxpaths_ebgp;
 453                 uint16_t maxpaths_ibgp;
 454                 uint16_t ibgp_flags;
 455 #define BGP_FLAG_IBGP_MULTIPATH_SAME_CLUSTERLEN (1 << 0)
 456         } maxpaths[AFI_MAX][SAFI_MAX];
 457
 458         _Atomic uint32_t wpkt_quanta; // max # packets to write per i/o cycle
 459         _Atomic uint32_t rpkt_quanta; // max # packets to read per i/o cycle
 460
 461         /* Automatic coalesce adjust on/off */
 462         bool heuristic_coalesce;
 463         /* Actual coalesce time */
 464         uint32_t coalesce_time;
 465
 466         /* Auto-shutdown new peers */
 467         bool autoshutdown;
 468
 469         uint32_t addpath_tx_id;
 470         int addpath_tx_used[AFI_MAX][SAFI_MAX];
 471
 472 #if ENABLE_BGP_VNC
 473         struct rfapi_cfg *rfapi_cfg;
 474         struct rfapi *rfapi;
 475 #endif
 476
 477         /* EVPN related information */
 478
 479         /* EVI hash table */
 480         struct hash *vnihash;
 481
 482         /* EVPN enable - advertise gateway macip routes */
 483         int advertise_gw_macip;
 484
 485         /* EVPN enable - advertise local VNIs and their MACs etc. */
 486         int advertise_all_vni;
 487
 488         /* EVPN - use RFC 8365 to auto-derive RT */
 489         int advertise_autort_rfc8365;
 490
 491         /* Hash table of Import RTs to EVIs */
 492         struct hash *import_rt_hash;
 493
 494         /* Hash table of VRF import RTs to VRFs */
 495         struct hash *vrf_import_rt_hash;
 496
 497         /* L3-VNI corresponding to this vrf */
 498         vni_t l3vni;
 499
 500         /* router-mac to be used in mac-ip routes for this vrf */
 501         struct ethaddr rmac;
 502
 503         /* originator ip - to be used as NH for type-5 routes */
 504         struct in_addr originator_ip;
 505
 506         /* vrf flags */
 507         uint32_t vrf_flags;
 508 #define BGP_VRF_AUTO                        (1 << 0)
 509 #define BGP_VRF_IMPORT_RT_CFGD              (1 << 1)
 510 #define BGP_VRF_EXPORT_RT_CFGD              (1 << 2)
 511 #define BGP_VRF_RD_CFGD                     (1 << 3)
 512 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY    (1 << 4)
 513
 514
 515         /* unique ID for auto derivation of RD for this vrf */
 516         uint16_t vrf_rd_id;
 517
 518         /* Automatically derived RD for this VRF */
 519         struct prefix_rd vrf_prd_auto;
 520
 521         /* RD for this VRF */
 522         struct prefix_rd vrf_prd;
 523
 524         /* import rt list for the vrf instance */
 525         struct list *vrf_import_rtl;
 526
 527         /* export rt list for the vrf instance */
 528         struct list *vrf_export_rtl;
 529
 530         /* list of corresponding l2vnis (struct bgpevpn) */
 531         struct list *l2vnis;
 532
 533         /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
 534         struct bgp_rmap adv_cmd_rmap[AFI_MAX][SAFI_MAX];
 535
 536         struct vpn_policy vpn_policy[AFI_MAX];
 537
 538         struct bgp_pbr_config *bgp_pbr_cfg;
 539
 540         /* local esi hash table */
 541         struct hash *esihash;
 542
 543         QOBJ_FIELDS
 544 };
 545 DECLARE_QOBJ_TYPE(bgp)
 546
 547 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
 548
 549 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp)                                        \
 550         (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT                           \
 551          || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF                           \
 552              && bgp->vrf_id != VRF_UNKNOWN))
 553
 554 /* BGP peer-group support. */
 555 struct peer_group {
 556         /* Name of the peer-group. */
 557         char *name;
 558
 559         /* Pointer to BGP.  */
 560         struct bgp *bgp;
 561
 562         /* Peer-group client list. */
 563         struct list *peer;
 564
 565         /** Dynamic neighbor listening ranges */
 566         struct list *listen_range[AFI_MAX];
 567
 568         /* Peer-group config */
 569         struct peer *conf;
 570 };
 571
 572 /* BGP Notify message format. */
 573 struct bgp_notify {
 574         uint8_t code;
 575         uint8_t subcode;
 576         char *data;
 577         bgp_size_t length;
 578         uint8_t *raw_data;
 579 };
 580
 581 /* Next hop self address. */
 582 struct bgp_nexthop {
 583         struct interface *ifp;
 584         struct in_addr v4;
 585         struct in6_addr v6_global;
 586         struct in6_addr v6_local;
 587 };
 588
 589 /* BGP addpath values */
 590 #define BGP_ADDPATH_RX     1
 591 #define BGP_ADDPATH_TX     2
 592 #define BGP_ADDPATH_ID_LEN 4
 593
 594 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
 595
 596 /* Route map direction */
 597 #define RMAP_IN  0
 598 #define RMAP_OUT 1
 599 #define RMAP_MAX 2
 600
 601 #include "filter.h"
 602
 603 /* BGP filter structure. */
 604 struct bgp_filter {
 605         /* Distribute-list.  */
 606         struct {
 607                 char *name;
 608                 struct access_list *alist;
 609         } dlist[FILTER_MAX];
 610
 611         /* Prefix-list.  */
 612         struct {
 613                 char *name;
 614                 struct prefix_list *plist;
 615         } plist[FILTER_MAX];
 616
 617         /* Filter-list.  */
 618         struct {
 619                 char *name;
 620                 struct as_list *aslist;
 621         } aslist[FILTER_MAX];
 622
 623         /* Route-map.  */
 624         struct {
 625                 char *name;
 626                 struct route_map *map;
 627         } map[RMAP_MAX];
 628
 629         /* Unsuppress-map.  */
 630         struct {
 631                 char *name;
 632                 struct route_map *map;
 633         } usmap;
 634 };
 635
 636 /* IBGP/EBGP identifier.  We also have a CONFED peer, which is to say,
 637    a peer who's AS is part of our Confederation.  */
 638 typedef enum {
 639         BGP_PEER_IBGP = 1,
 640         BGP_PEER_EBGP,
 641         BGP_PEER_INTERNAL,
 642         BGP_PEER_CONFED,
 643 } bgp_peer_sort_t;
 644
 645 /* BGP message header and packet size.  */
 646 #define BGP_MARKER_SIZE                         16
 647 #define BGP_HEADER_SIZE                         19
 648 #define BGP_MAX_PACKET_SIZE                   4096
 649 #define BGP_MAX_PACKET_SIZE_OVERFLOW          1024
 650
 651 /*
 652  * Trigger delay for bgp_announce_route().
 653  */
 654 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS  100
 655 #define BGP_ANNOUNCE_ROUTE_DELAY_MS        500
 656
 657 struct peer_af {
 658         /* back pointer to the peer */
 659         struct peer *peer;
 660
 661         /* which subgroup the peer_af belongs to */
 662         struct update_subgroup *subgroup;
 663
 664         /* for being part of an update subgroup's peer list */
 665         LIST_ENTRY(peer_af) subgrp_train;
 666
 667         /* for being part of a packet's peer list */
 668         LIST_ENTRY(peer_af) pkt_train;
 669
 670         struct bpacket *next_pkt_to_send;
 671
 672         /*
 673          * Trigger timer for bgp_announce_route().
 674          */
 675         struct thread *t_announce_route;
 676
 677         afi_t afi;
 678         safi_t safi;
 679         int afid;
 680 };
 681
 682 /* BGP neighbor structure. */
 683 struct peer {
 684         /* BGP structure.  */
 685         struct bgp *bgp;
 686
 687         /* reference count, primarily to allow bgp_process'ing of route_node's
 688          * to be done after a struct peer is deleted.
 689          *
 690          * named 'lock' for hysterical reasons within Quagga.
 691          */
 692         int lock;
 693
 694         /* BGP peer group.  */
 695         struct peer_group *group;
 696         uint64_t version[AFI_MAX][SAFI_MAX];
 697
 698         /* BGP peer_af structures, per configured AF on this peer */
 699         struct peer_af *peer_af_array[BGP_AF_MAX];
 700
 701         /* Peer's remote AS number. */
 702         int as_type;
 703         as_t as;
 704
 705         /* Peer's local AS number. */
 706         as_t local_as;
 707
 708         bgp_peer_sort_t sort;
 709
 710         /* Peer's Change local AS number. */
 711         as_t change_local_as;
 712
 713         /* Remote router ID. */
 714         struct in_addr remote_id;
 715
 716         /* Local router ID. */
 717         struct in_addr local_id;
 718
 719         /* Packet receive and send buffer. */
 720         pthread_mutex_t io_mtx;   // guards ibuf, obuf
 721         struct stream_fifo *ibuf; // packets waiting to be processed
 722         struct stream_fifo *obuf; // packets waiting to be written
 723
 724         struct ringbuf *ibuf_work; // WiP buffer used by bgp_read() only
 725         struct stream *obuf_work;  // WiP buffer used to construct packets
 726
 727         struct stream *curr; // the current packet being parsed
 728
 729         /* We use a separate stream to encode MP_REACH_NLRI for efficient
 730          * NLRI packing. peer->obuf_work stores all the other attributes. The
 731          * actual packet is then constructed by concatenating the two.
 732          */
 733         struct stream *scratch;
 734
 735         /* the doppelganger peer structure, due to dual TCP conn setup */
 736         struct peer *doppelganger;
 737
 738         /* Status of the peer. */
 739         int status;
 740         int ostatus;
 741
 742         /* FSM events, stored for debug purposes.
 743          * Note: uchar used for reduced memory usage.
 744          */
 745         unsigned char cur_event;
 746         unsigned char last_event;
 747         unsigned char last_major_event;
 748
 749         /* Peer index, used for dumping TABLE_DUMP_V2 format */
 750         uint16_t table_dump_index;
 751
 752         /* Peer information */
 753         int fd;              /* File descriptor */
 754         int ttl;             /* TTL of TCP connection to the peer. */
 755         int rtt;             /* Estimated round-trip-time from TCP_INFO */
 756         int gtsm_hops;       /* minimum hopcount to peer */
 757         char *desc;       /* Description of the peer. */
 758         unsigned short port; /* Destination port for peer */
 759         char *host;       /* Printable address of the peer. */
 760         union sockunion su;  /* Sockunion address of the peer. */
 761 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
 762         time_t uptime;       /* Last Up/Down time */
 763         time_t readtime;     /* Last read time */
 764         time_t resettime;    /* Last reset time */
 765
 766         char *conf_if;   /* neighbor interface config name. */
 767         struct interface *ifp; /* corresponding interface */
 768         char *ifname;     /* bind interface name. */
 769         char *update_if;
 770         union sockunion *update_source;
 771
 772         union sockunion *su_local;  /* Sockunion of local address.  */
 773         union sockunion *su_remote; /* Sockunion of remote address.  */
 774         int shared_network;      /* Is this peer shared same network. */
 775         struct bgp_nexthop nexthop; /* Nexthop */
 776
 777         /* Peer address family configuration. */
 778         uint8_t afc[AFI_MAX][SAFI_MAX];
 779         uint8_t afc_nego[AFI_MAX][SAFI_MAX];
 780         uint8_t afc_adv[AFI_MAX][SAFI_MAX];
 781         uint8_t afc_recv[AFI_MAX][SAFI_MAX];
 782
 783         /* Capability flags (reset in bgp_stop) */
 784         uint32_t cap;
 785 #define PEER_CAP_REFRESH_ADV                (1 << 0) /* refresh advertised */
 786 #define PEER_CAP_REFRESH_OLD_RCV            (1 << 1) /* refresh old received */
 787 #define PEER_CAP_REFRESH_NEW_RCV            (1 << 2) /* refresh rfc received */
 788 #define PEER_CAP_DYNAMIC_ADV                (1 << 3) /* dynamic advertised */
 789 #define PEER_CAP_DYNAMIC_RCV                (1 << 4) /* dynamic received */
 790 #define PEER_CAP_RESTART_ADV                (1 << 5) /* restart advertised */
 791 #define PEER_CAP_RESTART_RCV                (1 << 6) /* restart received */
 792 #define PEER_CAP_AS4_ADV                    (1 << 7) /* as4 advertised */
 793 #define PEER_CAP_AS4_RCV                    (1 << 8) /* as4 received */
 794 #define PEER_CAP_RESTART_BIT_ADV            (1 << 9) /* sent restart state */
 795 #define PEER_CAP_RESTART_BIT_RCV            (1 << 10) /* peer restart state */
 796 #define PEER_CAP_ADDPATH_ADV                (1 << 11) /* addpath advertised */
 797 #define PEER_CAP_ADDPATH_RCV                (1 << 12) /* addpath received */
 798 #define PEER_CAP_ENHE_ADV                   (1 << 13) /* Extended nexthop advertised */
 799 #define PEER_CAP_ENHE_RCV                   (1 << 14) /* Extended nexthop received */
 800 #define PEER_CAP_HOSTNAME_ADV               (1 << 15) /* hostname advertised */
 801 #define PEER_CAP_HOSTNAME_RCV               (1 << 16) /* hostname received */
 802
 803         /* Capability flags (reset in bgp_stop) */
 804         uint32_t af_cap[AFI_MAX][SAFI_MAX];
 805 #define PEER_CAP_ORF_PREFIX_SM_ADV          (1 << 0) /* send-mode advertised */
 806 #define PEER_CAP_ORF_PREFIX_RM_ADV          (1 << 1) /* receive-mode advertised */
 807 #define PEER_CAP_ORF_PREFIX_SM_RCV          (1 << 2) /* send-mode received */
 808 #define PEER_CAP_ORF_PREFIX_RM_RCV          (1 << 3) /* receive-mode received */
 809 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV      (1 << 4) /* send-mode received */
 810 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV      (1 << 5) /* receive-mode received */
 811 #define PEER_CAP_RESTART_AF_RCV             (1 << 6) /* graceful restart afi/safi received */
 812 #define PEER_CAP_RESTART_AF_PRESERVE_RCV    (1 << 7) /* graceful restart afi/safi F-bit received */
 813 #define PEER_CAP_ADDPATH_AF_TX_ADV          (1 << 8) /* addpath tx advertised */
 814 #define PEER_CAP_ADDPATH_AF_TX_RCV          (1 << 9) /* addpath tx received */
 815 #define PEER_CAP_ADDPATH_AF_RX_ADV          (1 << 10) /* addpath rx advertised */
 816 #define PEER_CAP_ADDPATH_AF_RX_RCV          (1 << 11) /* addpath rx received */
 817 #define PEER_CAP_ENHE_AF_ADV                (1 << 12) /* Extended nexthopi afi/safi advertised */
 818 #define PEER_CAP_ENHE_AF_RCV                (1 << 13) /* Extended nexthop afi/safi received */
 819 #define PEER_CAP_ENHE_AF_NEGO               (1 << 14) /* Extended nexthop afi/safi negotiated */
 820
 821         /* Global configuration flags. */
 822         /*
 823          * Parallel array to flags that indicates whether each flag originates
 824          * from a peer-group or if it is config that is specific to this
 825          * individual peer. If a flag is set independent of the peer-group, the
 826          * same bit should be set here. If this peer is a peer-group, this
 827          * memory region should be all zeros.
 828          *
 829          * The assumption is that the default state for all flags is unset,
 830          * so if a flag is unset, the corresponding override flag is unset too.
 831          * However if a flag is set, the corresponding override flag is set.
 832          */
 833         uint32_t flags_override;
 834         /*
 835          * Parallel array to flags that indicates whether the default behavior
 836          * of *flags_override* should be inverted. If a flag is unset and the
 837          * corresponding invert flag is set, the corresponding override flag
 838          * would be set. However if a flag is set and the corresponding invert
 839          * flag is unset, the corresponding override flag would be unset.
 840          *
 841          * This can be used for attributes like *send-community*, which are
 842          * implicitely enabled and have to be disabled explicitely, compared to
 843          * 'normal' attributes like *next-hop-self* which are implicitely set.
 844          *
 845          * All operations dealing with flags should apply the following boolean
 846          * logic to keep the internal flag system in a sane state:
 847          *
 848          * value=0 invert=0     Inherit flag if member, otherwise unset flag
 849          * value=0 invert=1     Unset flag unconditionally
 850          * value=1 invert=0     Set flag unconditionally
 851          * value=1 invert=1     Inherit flag if member, otherwise set flag
 852          *
 853          * Contrary to the implementation of *flags_override*, the flag
 854          * inversion state can be set either on the peer OR the peer *and* the
 855          * peer-group. This was done on purpose, as the inversion state of a
 856          * flag can be determined on either the peer or the peer-group.
 857          *
 858          * Example: Enabling the cisco configuration mode inverts all flags
 859          * related to *send-community* unconditionally for both peer-groups and
 860          * peers.
 861          *
 862          * This behavior is different for interface peers though, which enable
 863          * the *extended-nexthop* flag by default, which regular peers do not.
 864          * As the peer-group can contain both regular and interface peers, the
 865          * flag inversion state must be set on the peer only.
 866          *
 867          * When a peer inherits the configuration from a peer-group and the
 868          * inversion state of the flag differs between peer and peer-group, the
 869          * newly set value must equal to the inverted state of the peer-group.
 870          */
 871         uint32_t flags_invert;
 872         /*
 873          * Effective array for storing the peer/peer-group flags. In case of a
 874          * peer-group, the peer-specific overrides (see flags_override and
 875          * flags_invert) must be respected.
 876          */
 877         uint32_t flags;
 878 #define PEER_FLAG_PASSIVE                   (1 << 0) /* passive mode */
 879 #define PEER_FLAG_SHUTDOWN                  (1 << 1) /* shutdown */
 880 #define PEER_FLAG_DONT_CAPABILITY           (1 << 2) /* dont-capability */
 881 #define PEER_FLAG_OVERRIDE_CAPABILITY       (1 << 3) /* override-capability */
 882 #define PEER_FLAG_STRICT_CAP_MATCH          (1 << 4) /* strict-match */
 883 #define PEER_FLAG_DYNAMIC_CAPABILITY        (1 << 5) /* dynamic capability */
 884 #define PEER_FLAG_DISABLE_CONNECTED_CHECK   (1 << 6) /* disable-connected-check */
 885 #define PEER_FLAG_LOCAL_AS_NO_PREPEND       (1 << 7) /* local-as no-prepend */
 886 #define PEER_FLAG_LOCAL_AS_REPLACE_AS       (1 << 8) /* local-as no-prepend replace-as */
 887 #define PEER_FLAG_DELETE                    (1 << 9) /* mark the peer for deleting */
 888 #define PEER_FLAG_CONFIG_NODE               (1 << 10) /* the node to update configs on */
 889 #define PEER_FLAG_LONESOUL                  (1 << 11)
 890 #define PEER_FLAG_DYNAMIC_NEIGHBOR          (1 << 12) /* dynamic neighbor */
 891 #define PEER_FLAG_CAPABILITY_ENHE           (1 << 13) /* Extended next-hop (rfc 5549)*/
 892 #define PEER_FLAG_IFPEER_V6ONLY             (1 << 14) /* if-based peer is v6 only */
 893 #define PEER_FLAG_IS_RFAPI_HD               (1 << 15) /* attached to rfapi HD */
 894 #define PEER_FLAG_ENFORCE_FIRST_AS          (1 << 16) /* enforce-first-as */
 895 #define PEER_FLAG_ROUTEADV                  (1 << 17) /* route advertise */
 896 #define PEER_FLAG_TIMER                     (1 << 18) /* keepalive & holdtime */
 897 #define PEER_FLAG_TIMER_CONNECT             (1 << 19) /* connect timer */
 898 #define PEER_FLAG_PASSWORD                  (1 << 20) /* password */
 899 #define PEER_FLAG_LOCAL_AS                  (1 << 21) /* local-as */
 900 #define PEER_FLAG_UPDATE_SOURCE             (1 << 22) /* update-source */
 901
 902         /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
 903         char *tx_shutdown_message;
 904
 905         /* NSF mode (graceful restart) */
 906         uint8_t nsf[AFI_MAX][SAFI_MAX];
 907
 908         /* Peer Per AF flags */
 909         /*
 910          * Please consult the comments for *flags_override*, *flags_invert* and
 911          * *flags* to understand what these three arrays do. The address-family
 912          * specific attributes are being treated the exact same way as global
 913          * peer attributes.
 914          */
 915         uint32_t af_flags_override[AFI_MAX][SAFI_MAX];
 916         uint32_t af_flags_invert[AFI_MAX][SAFI_MAX];
 917         uint32_t af_flags[AFI_MAX][SAFI_MAX];
 918 #define PEER_FLAG_SEND_COMMUNITY            (1 << 0) /* send-community */
 919 #define PEER_FLAG_SEND_EXT_COMMUNITY        (1 << 1) /* send-community ext. */
 920 #define PEER_FLAG_NEXTHOP_SELF              (1 << 2) /* next-hop-self */
 921 #define PEER_FLAG_REFLECTOR_CLIENT          (1 << 3) /* reflector-client */
 922 #define PEER_FLAG_RSERVER_CLIENT            (1 << 4) /* route-server-client */
 923 #define PEER_FLAG_SOFT_RECONFIG             (1 << 5) /* soft-reconfiguration */
 924 #define PEER_FLAG_AS_PATH_UNCHANGED         (1 << 6) /* transparent-as */
 925 #define PEER_FLAG_NEXTHOP_UNCHANGED         (1 << 7) /* transparent-next-hop */
 926 #define PEER_FLAG_MED_UNCHANGED             (1 << 8) /* transparent-next-hop */
 927 #define PEER_FLAG_DEFAULT_ORIGINATE         (1 << 9) /* default-originate */
 928 #define PEER_FLAG_REMOVE_PRIVATE_AS         (1 << 10) /* remove-private-as */
 929 #define PEER_FLAG_ALLOWAS_IN                (1 << 11) /* set allowas-in */
 930 #define PEER_FLAG_ORF_PREFIX_SM             (1 << 12) /* orf capability send-mode */
 931 #define PEER_FLAG_ORF_PREFIX_RM             (1 << 13) /* orf capability receive-mode */
 932 #define PEER_FLAG_MAX_PREFIX                (1 << 14) /* maximum prefix */
 933 #define PEER_FLAG_MAX_PREFIX_WARNING        (1 << 15) /* maximum prefix warning-only */
 934 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED   (1 << 16) /* leave link-local nexthop unchanged */
 935 #define PEER_FLAG_FORCE_NEXTHOP_SELF        (1 << 17) /* next-hop-self force */
 936 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL     (1 << 18) /* remove-private-as all */
 937 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1 << 19) /* remove-private-as replace-as */
 938 #define PEER_FLAG_AS_OVERRIDE               (1 << 20) /* as-override */
 939 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1 << 21) /* remove-private-as all replace-as */
 940 #define PEER_FLAG_ADDPATH_TX_ALL_PATHS      (1 << 22) /* addpath-tx-all-paths */
 941 #define PEER_FLAG_ADDPATH_TX_BESTPATH_PER_AS (1 << 23) /* addpath-tx-bestpath-per-AS */
 942 #define PEER_FLAG_WEIGHT                    (1 << 24) /* weight */
 943 #define PEER_FLAG_ALLOWAS_IN_ORIGIN         (1 << 25) /* allowas-in origin */
 944 #define PEER_FLAG_SEND_LARGE_COMMUNITY      (1 << 26) /* Send large Communities */
 945
 946         /* MD5 password */
 947         char *password;
 948
 949         /* default-originate route-map.  */
 950         struct {
 951                 char *name;
 952                 struct route_map *map;
 953         } default_rmap[AFI_MAX][SAFI_MAX];
 954
 955         /* Peer status flags. */
 956         uint16_t sflags;
 957 #define PEER_STATUS_ACCEPT_PEER       (1 << 0) /* accept peer */
 958 #define PEER_STATUS_PREFIX_OVERFLOW   (1 << 1) /* prefix-overflow */
 959 #define PEER_STATUS_CAPABILITY_OPEN   (1 << 2) /* capability open send */
 960 #define PEER_STATUS_HAVE_ACCEPT       (1 << 3) /* accept peer's parent */
 961 #define PEER_STATUS_GROUP             (1 << 4) /* peer-group conf */
 962 #define PEER_STATUS_NSF_MODE          (1 << 5) /* NSF aware peer */
 963 #define PEER_STATUS_NSF_WAIT          (1 << 6) /* wait comeback peer */
 964
 965         /* Peer status af flags (reset in bgp_stop) */
 966         uint16_t af_sflags[AFI_MAX][SAFI_MAX];
 967 #define PEER_STATUS_ORF_PREFIX_SEND   (1 << 0) /* prefix-list send peer */
 968 #define PEER_STATUS_ORF_WAIT_REFRESH  (1 << 1) /* wait refresh received peer */
 969 #define PEER_STATUS_PREFIX_THRESHOLD  (1 << 2) /* exceed prefix-threshold */
 970 #define PEER_STATUS_PREFIX_LIMIT      (1 << 3) /* exceed prefix-limit */
 971 #define PEER_STATUS_EOR_SEND          (1 << 4) /* end-of-rib send to peer */
 972 #define PEER_STATUS_EOR_RECEIVED      (1 << 5) /* end-of-rib received from peer */
 973
 974         /* Configured timer values. */
 975         _Atomic uint32_t holdtime;
 976         _Atomic uint32_t keepalive;
 977         _Atomic uint32_t connect;
 978         _Atomic uint32_t routeadv;
 979
 980         /* Timer values. */
 981         _Atomic uint32_t v_start;
 982         _Atomic uint32_t v_connect;
 983         _Atomic uint32_t v_holdtime;
 984         _Atomic uint32_t v_keepalive;
 985         _Atomic uint32_t v_routeadv;
 986         _Atomic uint32_t v_pmax_restart;
 987         _Atomic uint32_t v_gr_restart;
 988
 989         /* Threads. */
 990         struct thread *t_read;
 991         struct thread *t_write;
 992         struct thread *t_start;
 993         struct thread *t_connect_check_r;
 994         struct thread *t_connect_check_w;
 995         struct thread *t_connect;
 996         struct thread *t_holdtime;
 997         struct thread *t_routeadv;
 998         struct thread *t_pmax_restart;
 999         struct thread *t_gr_restart;
1000         struct thread *t_gr_stale;
1001         struct thread *t_generate_updgrp_packets;
1002         struct thread *t_process_packet;
1003
1004         /* Thread flags. */
1005         _Atomic uint16_t thread_flags;
1006 #define PEER_THREAD_WRITES_ON         (1 << 0)
1007 #define PEER_THREAD_READS_ON          (1 << 1)
1008 #define PEER_THREAD_KEEPALIVES_ON     (1 << 2)
1009         /* workqueues */
1010         struct work_queue *clear_node_queue;
1011
1012 #define PEER_TOTAL_RX(peer)                                                    \
1013         atomic_load_explicit(&peer->open_in, memory_order_relaxed)             \
1014                 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1015                 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1016                 + atomic_load_explicit(&peer->refresh_in,                      \
1017                                        memory_order_relaxed)                   \
1018                 + atomic_load_explicit(&peer->keepalive_in,                    \
1019                                        memory_order_relaxed)                   \
1020                 + atomic_load_explicit(&peer->dynamic_cap_in,                  \
1021                                        memory_order_relaxed)
1022
1023 #define PEER_TOTAL_TX(peer)                                                    \
1024         atomic_load_explicit(&peer->open_out, memory_order_relaxed)            \
1025                 + atomic_load_explicit(&peer->update_out,                      \
1026                                        memory_order_relaxed)                   \
1027                 + atomic_load_explicit(&peer->notify_out,                      \
1028                                        memory_order_relaxed)                   \
1029                 + atomic_load_explicit(&peer->refresh_out,                     \
1030                                        memory_order_relaxed)                   \
1031                 + atomic_load_explicit(&peer->keepalive_out,                   \
1032                                        memory_order_relaxed)                   \
1033                 + atomic_load_explicit(&peer->dynamic_cap_out,                 \
1034                                        memory_order_relaxed)
1035
1036         /* Statistics field */
1037         _Atomic uint32_t open_in;        /* Open message input count */
1038         _Atomic uint32_t open_out;      /* Open message output count */
1039         _Atomic uint32_t update_in;       /* Update message input count */
1040         _Atomic uint32_t update_out;      /* Update message ouput count */
1041         _Atomic time_t update_time;       /* Update message received time. */
1042         _Atomic uint32_t keepalive_in;    /* Keepalive input count */
1043         _Atomic uint32_t keepalive_out;   /* Keepalive output count */
1044         _Atomic uint32_t notify_in;       /* Notify input count */
1045         _Atomic uint32_t notify_out;      /* Notify output count */
1046         _Atomic uint32_t refresh_in;      /* Route Refresh input count */
1047         _Atomic uint32_t refresh_out;     /* Route Refresh output count */
1048         _Atomic uint32_t dynamic_cap_in;  /* Dynamic Capability input count.  */
1049         _Atomic uint32_t dynamic_cap_out; /* Dynamic Capability output count. */
1050
1051         /* BGP state count */
1052         uint32_t established; /* Established */
1053         uint32_t dropped;     /* Dropped */
1054
1055         /* Update delay related fields */
1056         uint8_t update_delay_over; /* When this is set, BGP is no more waiting
1057                                      for EOR */
1058
1059         /* Syncronization list and time.  */
1060         struct bgp_synchronize *sync[AFI_MAX][SAFI_MAX];
1061         time_t synctime;
1062         /* timestamp when the last UPDATE msg was written */
1063         _Atomic time_t last_write;
1064         /* timestamp when the last msg was written */
1065         _Atomic time_t last_update;
1066
1067         /* Send prefix count. */
1068         unsigned long scount[AFI_MAX][SAFI_MAX];
1069
1070         /* Notify data. */
1071         struct bgp_notify notify;
1072
1073         /* Filter structure. */
1074         struct bgp_filter filter[AFI_MAX][SAFI_MAX];
1075
1076         /*
1077          * Parallel array to filter that indicates whether each filter
1078          * originates from a peer-group or if it is config that is specific to
1079          * this individual peer. If a filter is set independent of the
1080          * peer-group the appropriate bit should be set here. If this peer is a
1081          * peer-group, this memory region should be all zeros. The assumption
1082          * is that the default state for all flags is unset. Due to filters
1083          * having a direction (e.g. in/out/...), this array has a third
1084          * dimension for storing the overrides independently per direction.
1085          *
1086          * Notes:
1087          * - if a filter for an individual peer is unset, the corresponding
1088          *   override flag is unset and the peer is considered to be back in
1089          *   sync with the peer-group.
1090          * - This does *not* contain the filter values, rather it contains
1091          *   whether the filter in filter (struct bgp_filter) is peer-specific.
1092          */
1093         uint8_t filter_override[AFI_MAX][SAFI_MAX][(FILTER_MAX > RMAP_MAX)
1094                                                            ? FILTER_MAX
1095                                                            : RMAP_MAX];
1096 #define PEER_FT_DISTRIBUTE_LIST       (1 << 0) /* distribute-list */
1097 #define PEER_FT_FILTER_LIST           (1 << 1) /* filter-list */
1098 #define PEER_FT_PREFIX_LIST           (1 << 2) /* prefix-list */
1099 #define PEER_FT_ROUTE_MAP             (1 << 3) /* route-map */
1100 #define PEER_FT_UNSUPPRESS_MAP        (1 << 4) /* unsuppress-map */
1101
1102         /* ORF Prefix-list */
1103         struct prefix_list *orf_plist[AFI_MAX][SAFI_MAX];
1104
1105         /* Text description of last attribute rcvd */
1106         char rcvd_attr_str[BUFSIZ];
1107
1108         /* Track if we printed the attribute in debugs */
1109         int rcvd_attr_printed;
1110
1111         /* Prefix count. */
1112         unsigned long pcount[AFI_MAX][SAFI_MAX];
1113
1114         /* Max prefix count. */
1115         unsigned long pmax[AFI_MAX][SAFI_MAX];
1116         uint8_t pmax_threshold[AFI_MAX][SAFI_MAX];
1117         uint16_t pmax_restart[AFI_MAX][SAFI_MAX];
1118 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1119
1120         /* allowas-in. */
1121         char allowas_in[AFI_MAX][SAFI_MAX];
1122
1123         /* weight */
1124         unsigned long weight[AFI_MAX][SAFI_MAX];
1125
1126         /* peer reset cause */
1127         char last_reset;
1128 #define PEER_DOWN_RID_CHANGE             1 /* bgp router-id command */
1129 #define PEER_DOWN_REMOTE_AS_CHANGE       2 /* neighbor remote-as command */
1130 #define PEER_DOWN_LOCAL_AS_CHANGE        3 /* neighbor local-as command */
1131 #define PEER_DOWN_CLID_CHANGE            4 /* bgp cluster-id command */
1132 #define PEER_DOWN_CONFED_ID_CHANGE       5 /* bgp confederation identifier command */
1133 #define PEER_DOWN_CONFED_PEER_CHANGE     6 /* bgp confederation peer command */
1134 #define PEER_DOWN_RR_CLIENT_CHANGE       7 /* neighbor route-reflector-client command */
1135 #define PEER_DOWN_RS_CLIENT_CHANGE       8 /* neighbor route-server-client command */
1136 #define PEER_DOWN_UPDATE_SOURCE_CHANGE   9 /* neighbor update-source command */
1137 #define PEER_DOWN_AF_ACTIVATE           10 /* neighbor activate command */
1138 #define PEER_DOWN_USER_SHUTDOWN         11 /* neighbor shutdown command */
1139 #define PEER_DOWN_USER_RESET            12 /* clear ip bgp command */
1140 #define PEER_DOWN_NOTIFY_RECEIVED       13 /* notification received */
1141 #define PEER_DOWN_NOTIFY_SEND           14 /* notification send */
1142 #define PEER_DOWN_CLOSE_SESSION         15 /* tcp session close */
1143 #define PEER_DOWN_NEIGHBOR_DELETE       16 /* neghbor delete */
1144 #define PEER_DOWN_RMAP_BIND             17 /* neghbor peer-group command */
1145 #define PEER_DOWN_RMAP_UNBIND           18 /* no neighbor peer-group command */
1146 #define PEER_DOWN_CAPABILITY_CHANGE     19 /* neighbor capability command */
1147 #define PEER_DOWN_PASSIVE_CHANGE        20 /* neighbor passive command */
1148 #define PEER_DOWN_MULTIHOP_CHANGE       21 /* neighbor multihop command */
1149 #define PEER_DOWN_NSF_CLOSE_SESSION     22 /* NSF tcp session close */
1150 #define PEER_DOWN_V6ONLY_CHANGE         23 /* if-based peering v6only toggled */
1151 #define PEER_DOWN_BFD_DOWN              24 /* BFD down */
1152 #define PEER_DOWN_IF_DOWN               25 /* Interface down */
1153 #define PEER_DOWN_NBR_ADDR_DEL          26 /* Peer address lost */
1154         unsigned long last_reset_cause_size;
1155         uint8_t last_reset_cause[BGP_MAX_PACKET_SIZE];
1156
1157         /* The kind of route-map Flags.*/
1158         uint8_t rmap_type;
1159 #define PEER_RMAP_TYPE_IN             (1 << 0) /* neighbor route-map in */
1160 #define PEER_RMAP_TYPE_OUT            (1 << 1) /* neighbor route-map out */
1161 #define PEER_RMAP_TYPE_NETWORK        (1 << 2) /* network route-map */
1162 #define PEER_RMAP_TYPE_REDISTRIBUTE   (1 << 3) /* redistribute route-map */
1163 #define PEER_RMAP_TYPE_DEFAULT        (1 << 4) /* default-originate route-map */
1164 #define PEER_RMAP_TYPE_NOSET          (1 << 5) /* not allow to set commands */
1165 #define PEER_RMAP_TYPE_IMPORT         (1 << 6) /* neighbor route-map import */
1166 #define PEER_RMAP_TYPE_EXPORT         (1 << 7) /* neighbor route-map export */
1167
1168         /* peer specific BFD information */
1169         struct bfd_info *bfd_info;
1170
1171         /* hostname and domainname advertised by host */
1172         char *hostname;
1173         char *domainname;
1174
1175         QOBJ_FIELDS
1176 };
1177 DECLARE_QOBJ_TYPE(peer)
1178
1179 /* Inherit peer attribute from peer-group. */
1180 #define PEER_ATTR_INHERIT(peer, group, attr)                                   \
1181         ((peer)->attr = (group)->conf->attr)
1182 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt)                           \
1183         do {                                                                   \
1184                 if ((peer)->attr)                                              \
1185                         XFREE(mt, (peer)->attr);                               \
1186                 if ((group)->conf->attr)                                       \
1187                         (peer)->attr = XSTRDUP(mt, (group)->conf->attr);       \
1188                 else                                                           \
1189                         (peer)->attr = NULL;                                   \
1190         } while (0)
1191 #define PEER_SU_ATTR_INHERIT(peer, group, attr)                                \
1192         do {                                                                   \
1193                 if ((peer)->attr)                                              \
1194                         sockunion_free((peer)->attr);                          \
1195                 if ((group)->conf->attr)                                       \
1196                         (peer)->attr = sockunion_dup((group)->conf->attr);     \
1197                 else                                                           \
1198                         (peer)->attr = NULL;                                   \
1199         } while (0)
1200
1201 /* Check if suppress start/restart of sessions to peer. */
1202 #define BGP_PEER_START_SUPPRESSED(P)                                           \
1203         (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN)                            \
1204          || CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW))
1205
1206 #define PEER_PASSWORD_MINLEN    (1)
1207 #define PEER_PASSWORD_MAXLEN    (80)
1208
1209 /* This structure's member directly points incoming packet data
1210    stream. */
1211 struct bgp_nlri {
1212         /* AFI.  */
1213         uint16_t afi; /* iana_afi_t */
1214
1215         /* SAFI.  */
1216         uint8_t safi; /* iana_safi_t */
1217
1218         /* Pointer to NLRI byte stream.  */
1219         uint8_t *nlri;
1220
1221         /* Length of whole NLRI.  */
1222         bgp_size_t length;
1223 };
1224
1225 /* BGP versions.  */
1226 #define BGP_VERSION_4                            4
1227
1228 /* Default BGP port number.  */
1229 #define BGP_PORT_DEFAULT                       179
1230
1231 /* BGP minimum message size.  */
1232 #define BGP_MSG_OPEN_MIN_SIZE                   (BGP_HEADER_SIZE + 10)
1233 #define BGP_MSG_UPDATE_MIN_SIZE                 (BGP_HEADER_SIZE + 4)
1234 #define BGP_MSG_NOTIFY_MIN_SIZE                 (BGP_HEADER_SIZE + 2)
1235 #define BGP_MSG_KEEPALIVE_MIN_SIZE              (BGP_HEADER_SIZE + 0)
1236 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE          (BGP_HEADER_SIZE + 4)
1237 #define BGP_MSG_CAPABILITY_MIN_SIZE             (BGP_HEADER_SIZE + 3)
1238
1239 /* BGP message types.  */
1240 #define BGP_MSG_OPEN                             1
1241 #define BGP_MSG_UPDATE                           2
1242 #define BGP_MSG_NOTIFY                           3
1243 #define BGP_MSG_KEEPALIVE                        4
1244 #define BGP_MSG_ROUTE_REFRESH_NEW                5
1245 #define BGP_MSG_CAPABILITY                       6
1246 #define BGP_MSG_ROUTE_REFRESH_OLD              128
1247
1248 /* BGP open optional parameter.  */
1249 #define BGP_OPEN_OPT_AUTH                        1
1250 #define BGP_OPEN_OPT_CAP                         2
1251
1252 /* BGP4 attribute type codes.  */
1253 #define BGP_ATTR_ORIGIN                          1
1254 #define BGP_ATTR_AS_PATH                         2
1255 #define BGP_ATTR_NEXT_HOP                        3
1256 #define BGP_ATTR_MULTI_EXIT_DISC                 4
1257 #define BGP_ATTR_LOCAL_PREF                      5
1258 #define BGP_ATTR_ATOMIC_AGGREGATE                6
1259 #define BGP_ATTR_AGGREGATOR                      7
1260 #define BGP_ATTR_COMMUNITIES                     8
1261 #define BGP_ATTR_ORIGINATOR_ID                   9
1262 #define BGP_ATTR_CLUSTER_LIST                   10
1263 #define BGP_ATTR_DPA                            11
1264 #define BGP_ATTR_ADVERTISER                     12
1265 #define BGP_ATTR_RCID_PATH                      13
1266 #define BGP_ATTR_MP_REACH_NLRI                  14
1267 #define BGP_ATTR_MP_UNREACH_NLRI                15
1268 #define BGP_ATTR_EXT_COMMUNITIES                16
1269 #define BGP_ATTR_AS4_PATH                       17
1270 #define BGP_ATTR_AS4_AGGREGATOR                 18
1271 #define BGP_ATTR_AS_PATHLIMIT                   21
1272 #define BGP_ATTR_PMSI_TUNNEL                    22
1273 #define BGP_ATTR_ENCAP                          23
1274 #define BGP_ATTR_LARGE_COMMUNITIES              32
1275 #define BGP_ATTR_PREFIX_SID                     40
1276 #if ENABLE_BGP_VNC_ATTR
1277 #define BGP_ATTR_VNC                           255
1278 #endif
1279
1280 /* BGP update origin.  */
1281 #define BGP_ORIGIN_IGP                           0
1282 #define BGP_ORIGIN_EGP                           1
1283 #define BGP_ORIGIN_INCOMPLETE                    2
1284
1285 /* BGP notify message codes.  */
1286 #define BGP_NOTIFY_HEADER_ERR                    1
1287 #define BGP_NOTIFY_OPEN_ERR                      2
1288 #define BGP_NOTIFY_UPDATE_ERR                    3
1289 #define BGP_NOTIFY_HOLD_ERR                      4
1290 #define BGP_NOTIFY_FSM_ERR                       5
1291 #define BGP_NOTIFY_CEASE                         6
1292 #define BGP_NOTIFY_CAPABILITY_ERR                7
1293
1294 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC            0
1295
1296 /* BGP_NOTIFY_HEADER_ERR sub codes.  */
1297 #define BGP_NOTIFY_HEADER_NOT_SYNC               1
1298 #define BGP_NOTIFY_HEADER_BAD_MESLEN             2
1299 #define BGP_NOTIFY_HEADER_BAD_MESTYPE            3
1300
1301 /* BGP_NOTIFY_OPEN_ERR sub codes.  */
1302 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR           0
1303 #define BGP_NOTIFY_OPEN_UNSUP_VERSION            1
1304 #define BGP_NOTIFY_OPEN_BAD_PEER_AS              2
1305 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT            3
1306 #define BGP_NOTIFY_OPEN_UNSUP_PARAM              4
1307 #define BGP_NOTIFY_OPEN_AUTH_FAILURE             5
1308 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME          6
1309 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL              7
1310
1311 /* BGP_NOTIFY_UPDATE_ERR sub codes.  */
1312 #define BGP_NOTIFY_UPDATE_MAL_ATTR               1
1313 #define BGP_NOTIFY_UPDATE_UNREC_ATTR             2
1314 #define BGP_NOTIFY_UPDATE_MISS_ATTR              3
1315 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR          4
1316 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR          5
1317 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN           6
1318 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP          7
1319 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP         8
1320 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR           9
1321 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK         10
1322 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH           11
1323
1324 /* BGP_NOTIFY_CEASE sub codes (RFC 4486).  */
1325 #define BGP_NOTIFY_CEASE_MAX_PREFIX              1
1326 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN          2
1327 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG           3
1328 #define BGP_NOTIFY_CEASE_ADMIN_RESET             4
1329 #define BGP_NOTIFY_CEASE_CONNECT_REJECT          5
1330 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE           6
1331 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION    7
1332 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE         8
1333
1334 /* BGP_NOTIFY_CAPABILITY_ERR sub codes (draft-ietf-idr-dynamic-cap-02). */
1335 #define BGP_NOTIFY_CAPABILITY_INVALID_ACTION     1
1336 #define BGP_NOTIFY_CAPABILITY_INVALID_LENGTH     2
1337 #define BGP_NOTIFY_CAPABILITY_MALFORMED_CODE     3
1338
1339 /* BGP finite state machine status.  */
1340 #define Idle                                     1
1341 #define Connect                                  2
1342 #define Active                                   3
1343 #define OpenSent                                 4
1344 #define OpenConfirm                              5
1345 #define Established                              6
1346 #define Clearing                                 7
1347 #define Deleted                                  8
1348 #define BGP_STATUS_MAX                           9
1349
1350 /* BGP finite state machine events.  */
1351 #define BGP_Start                                1
1352 #define BGP_Stop                                 2
1353 #define TCP_connection_open                      3
1354 #define TCP_connection_closed                    4
1355 #define TCP_connection_open_failed               5
1356 #define TCP_fatal_error                          6
1357 #define ConnectRetry_timer_expired               7
1358 #define Hold_Timer_expired                       8
1359 #define KeepAlive_timer_expired                  9
1360 #define Receive_OPEN_message                    10
1361 #define Receive_KEEPALIVE_message               11
1362 #define Receive_UPDATE_message                  12
1363 #define Receive_NOTIFICATION_message            13
1364 #define Clearing_Completed                      14
1365 #define BGP_EVENTS_MAX                          15
1366
1367 /* BGP timers default value.  */
1368 /* note: the DFLT_ ones depend on compile-time "defaults" selection */
1369 #define BGP_INIT_START_TIMER                     1
1370 #define BGP_DEFAULT_HOLDTIME                      DFLT_BGP_HOLDTIME
1371 #define BGP_DEFAULT_KEEPALIVE                     DFLT_BGP_KEEPALIVE
1372 #define BGP_DEFAULT_EBGP_ROUTEADV                0
1373 #define BGP_DEFAULT_IBGP_ROUTEADV                0
1374 #define BGP_DEFAULT_CONNECT_RETRY                 DFLT_BGP_TIMERS_CONNECT
1375
1376 /* BGP default local preference.  */
1377 #define BGP_DEFAULT_LOCAL_PREF                 100
1378
1379 /* BGP local-preference to send when 'bgp graceful-shutdown'
1380  * is configured */
1381 #define BGP_GSHUT_LOCAL_PREF                     0
1382
1383 /* BGP default subgroup packet queue max .  */
1384 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX      40
1385
1386 /* BGP graceful restart  */
1387 #define BGP_DEFAULT_RESTART_TIME               120
1388 #define BGP_DEFAULT_STALEPATH_TIME             360
1389
1390 /* BGP uptime string length.  */
1391 #define BGP_UPTIME_LEN 25
1392
1393 /* Default configuration settings for bgpd.  */
1394 #define BGP_VTY_PORT                          2605
1395 #define BGP_DEFAULT_CONFIG             "bgpd.conf"
1396
1397 /* Check AS path loop when we send NLRI.  */
1398 /* #define BGP_SEND_ASPATH_CHECK */
1399
1400 /* BGP Dynamic Neighbors feature */
1401 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT    100
1402 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN          1
1403 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX       5000
1404
1405 /* Flag for peer_clear_soft().  */
1406 enum bgp_clear_type {
1407         BGP_CLEAR_SOFT_NONE,
1408         BGP_CLEAR_SOFT_OUT,
1409         BGP_CLEAR_SOFT_IN,
1410         BGP_CLEAR_SOFT_BOTH,
1411         BGP_CLEAR_SOFT_IN_ORF_PREFIX
1412 };
1413
1414 /* Macros. */
1415 #define BGP_INPUT(P)         ((P)->curr)
1416 #define BGP_INPUT_PNT(P)     (stream_pnt(BGP_INPUT(P)))
1417 #define BGP_IS_VALID_STATE_FOR_NOTIF(S)                                        \
1418         (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
1419
1420 /* BGP error codes.  */
1421 #define BGP_SUCCESS                               0
1422 #define BGP_ERR_INVALID_VALUE                    -1
1423 #define BGP_ERR_INVALID_FLAG                     -2
1424 #define BGP_ERR_INVALID_AS                       -3
1425 #define BGP_ERR_INVALID_BGP                      -4
1426 #define BGP_ERR_PEER_GROUP_MEMBER                -5
1427 #define BGP_ERR_MULTIPLE_INSTANCE_USED           -6
1428 #define BGP_ERR_PEER_GROUP_NO_REMOTE_AS          -7
1429 #define BGP_ERR_PEER_GROUP_CANT_CHANGE           -8
1430 #define BGP_ERR_PEER_GROUP_MISMATCH              -9
1431 #define BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT  -10
1432 #define BGP_ERR_MULTIPLE_INSTANCE_NOT_SET       -11
1433 #define BGP_ERR_AS_MISMATCH                     -12
1434 #define BGP_ERR_PEER_FLAG_CONFLICT              -13
1435 #define BGP_ERR_PEER_GROUP_SHUTDOWN             -14
1436 #define BGP_ERR_PEER_FILTER_CONFLICT            -15
1437 #define BGP_ERR_NOT_INTERNAL_PEER               -16
1438 #define BGP_ERR_REMOVE_PRIVATE_AS               -17
1439 #define BGP_ERR_AF_UNCONFIGURED                 -18
1440 #define BGP_ERR_SOFT_RECONFIG_UNCONFIGURED      -19
1441 #define BGP_ERR_INSTANCE_MISMATCH               -20
1442 #define BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP  -21
1443 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS    -22
1444 #define BGP_ERR_TCPSIG_FAILED                   -23
1445 #define BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK   -24
1446 #define BGP_ERR_NO_IBGP_WITH_TTLHACK            -25
1447 #define BGP_ERR_NO_INTERFACE_CONFIG             -26
1448 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS    -27
1449 #define BGP_ERR_AS_OVERRIDE                     -28
1450 #define BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT -29
1451 #define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS  -30
1452 #define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND -31
1453 #define BGP_ERR_INVALID_FOR_DYNAMIC_PEER        -32
1454 #define BGP_ERR_MAX                             -33
1455 #define BGP_ERR_INVALID_FOR_DIRECT_PEER         -34
1456 #define BGP_ERR_PEER_SAFI_CONFLICT              -35
1457
1458 /*
1459  * Enumeration of different policy kinds a peer can be configured with.
1460  */
1461 typedef enum {
1462         BGP_POLICY_ROUTE_MAP,
1463         BGP_POLICY_FILTER_LIST,
1464         BGP_POLICY_PREFIX_LIST,
1465         BGP_POLICY_DISTRIBUTE_LIST,
1466 } bgp_policy_type_e;
1467
1468 extern struct bgp_master *bm;
1469 extern unsigned int multipath_num;
1470
1471 /* Prototypes. */
1472 extern void bgp_terminate(void);
1473 extern void bgp_reset(void);
1474 extern time_t bgp_clock(void);
1475 extern void bgp_zclient_reset(void);
1476 extern struct bgp *bgp_get_default(void);
1477 extern struct bgp *bgp_lookup(as_t, const char *);
1478 extern struct bgp *bgp_lookup_by_name(const char *);
1479 extern struct bgp *bgp_lookup_by_vrf_id(vrf_id_t);
1480 extern struct peer *peer_lookup(struct bgp *, union sockunion *);
1481 extern struct peer *peer_lookup_by_conf_if(struct bgp *, const char *);
1482 extern struct peer *peer_lookup_by_hostname(struct bgp *, const char *);
1483 extern void bgp_peer_conf_if_to_su_update(struct peer *);
1484 extern int peer_group_listen_range_del(struct peer_group *, struct prefix *);
1485 extern struct peer_group *peer_group_lookup(struct bgp *, const char *);
1486 extern struct peer_group *peer_group_get(struct bgp *, const char *);
1487 extern struct peer *peer_create_bind_dynamic_neighbor(struct bgp *,
1488                                                       union sockunion *,
1489                                                       struct peer_group *);
1490 extern struct prefix *
1491 peer_group_lookup_dynamic_neighbor_range(struct peer_group *, struct prefix *);
1492 extern struct peer_group *peer_group_lookup_dynamic_neighbor(struct bgp *,
1493                                                              struct prefix *,
1494                                                              struct prefix **);
1495 extern struct peer *peer_lookup_dynamic_neighbor(struct bgp *,
1496                                                  union sockunion *);
1497
1498 /*
1499  * Peers are incredibly easy to memory leak
1500  * due to the various ways that they are actually used
1501  * Provide some functionality to debug locks and unlocks
1502  */
1503 extern struct peer *peer_lock_with_caller(const char *, struct peer *);
1504 extern struct peer *peer_unlock_with_caller(const char *, struct peer *);
1505 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
1506 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
1507
1508 extern bgp_peer_sort_t peer_sort(struct peer *peer);
1509 extern int peer_active(struct peer *);
1510 extern int peer_active_nego(struct peer *);
1511 extern void bgp_recalculate_all_bestpaths(struct bgp *bgp);
1512 extern struct peer *peer_create(union sockunion *, const char *, struct bgp *,
1513                                 as_t, as_t, int, afi_t, safi_t,
1514                                 struct peer_group *);
1515 extern struct peer *peer_create_accept(struct bgp *);
1516 extern void peer_xfer_config(struct peer *dst, struct peer *src);
1517 extern char *peer_uptime(time_t, char *, size_t, uint8_t, json_object *);
1518
1519 extern int bgp_config_write(struct vty *);
1520
1521 extern void bgp_master_init(struct thread_master *master);
1522
1523 extern void bgp_init(unsigned short instance);
1524 extern void bgp_pthreads_run(void);
1525 extern void bgp_pthreads_finish(void);
1526 extern void bgp_route_map_init(void);
1527 extern void bgp_session_reset(struct peer *);
1528
1529 extern int bgp_option_set(int);
1530 extern int bgp_option_unset(int);
1531 extern int bgp_option_check(int);
1532
1533 extern int bgp_get(struct bgp **, as_t *, const char *, enum bgp_instance_type);
1534 extern void bgp_instance_up(struct bgp *);
1535 extern void bgp_instance_down(struct bgp *);
1536 extern int bgp_delete(struct bgp *);
1537
1538 extern int bgp_handle_socket(struct bgp *bgp, struct vrf *vrf,
1539                              vrf_id_t old_vrf_id, bool create);
1540
1541 extern int bgp_flag_set(struct bgp *, int);
1542 extern int bgp_flag_unset(struct bgp *, int);
1543 extern int bgp_flag_check(struct bgp *, int);
1544
1545 extern void bgp_router_id_zebra_bump(vrf_id_t, const struct prefix *);
1546 extern int bgp_router_id_static_set(struct bgp *, struct in_addr);
1547
1548 extern int bgp_cluster_id_set(struct bgp *, struct in_addr *);
1549 extern int bgp_cluster_id_unset(struct bgp *);
1550
1551 extern int bgp_confederation_id_set(struct bgp *, as_t);
1552 extern int bgp_confederation_id_unset(struct bgp *);
1553 extern int bgp_confederation_peers_check(struct bgp *, as_t);
1554
1555 extern int bgp_confederation_peers_add(struct bgp *, as_t);
1556 extern int bgp_confederation_peers_remove(struct bgp *, as_t);
1557
1558 extern int bgp_timers_set(struct bgp *, uint32_t keepalive, uint32_t holdtime);
1559 extern int bgp_timers_unset(struct bgp *);
1560
1561 extern int bgp_default_local_preference_set(struct bgp *, uint32_t);
1562 extern int bgp_default_local_preference_unset(struct bgp *);
1563
1564 extern int bgp_default_subgroup_pkt_queue_max_set(struct bgp *bgp, uint32_t);
1565 extern int bgp_default_subgroup_pkt_queue_max_unset(struct bgp *bgp);
1566
1567 extern int bgp_listen_limit_set(struct bgp *, int);
1568 extern int bgp_listen_limit_unset(struct bgp *);
1569
1570 extern int bgp_update_delay_active(struct bgp *);
1571 extern int bgp_update_delay_configured(struct bgp *);
1572 extern int bgp_afi_safi_peer_exists(struct bgp *bgp, afi_t afi, safi_t safi);
1573 extern void peer_as_change(struct peer *, as_t, int);
1574 extern int peer_remote_as(struct bgp *, union sockunion *, const char *, as_t *,
1575                           int, afi_t, safi_t);
1576 extern int peer_group_remote_as(struct bgp *, const char *, as_t *, int);
1577 extern int peer_delete(struct peer *peer);
1578 extern int peer_group_delete(struct peer_group *);
1579 extern int peer_group_remote_as_delete(struct peer_group *);
1580 extern int peer_group_listen_range_add(struct peer_group *, struct prefix *);
1581
1582 extern int peer_activate(struct peer *, afi_t, safi_t);
1583 extern int peer_deactivate(struct peer *, afi_t, safi_t);
1584 extern int peer_afc_set(struct peer *, afi_t, safi_t, int);
1585
1586 extern int peer_group_bind(struct bgp *, union sockunion *, struct peer *,
1587                            struct peer_group *, as_t *);
1588
1589 extern int peer_flag_set(struct peer *, uint32_t);
1590 extern int peer_flag_unset(struct peer *, uint32_t);
1591 extern void peer_flag_inherit(struct peer *peer, uint32_t flag);
1592
1593 extern int peer_af_flag_set(struct peer *, afi_t, safi_t, uint32_t);
1594 extern int peer_af_flag_unset(struct peer *, afi_t, safi_t, uint32_t);
1595 extern int peer_af_flag_check(struct peer *, afi_t, safi_t, uint32_t);
1596 extern void peer_af_flag_inherit(struct peer *peer, afi_t afi, safi_t safi,
1597                                  uint32_t flag);
1598
1599 extern int peer_ebgp_multihop_set(struct peer *, int);
1600 extern int peer_ebgp_multihop_unset(struct peer *);
1601 extern int is_ebgp_multihop_configured(struct peer *peer);
1602
1603 extern int peer_description_set(struct peer *, const char *);
1604 extern int peer_description_unset(struct peer *);
1605
1606 extern int peer_update_source_if_set(struct peer *, const char *);
1607 extern int peer_update_source_addr_set(struct peer *, const union sockunion *);
1608 extern int peer_update_source_unset(struct peer *);
1609
1610 extern int peer_default_originate_set(struct peer *, afi_t, safi_t,
1611                                       const char *);
1612 extern int peer_default_originate_unset(struct peer *, afi_t, safi_t);
1613
1614 extern int peer_port_set(struct peer *, uint16_t);
1615 extern int peer_port_unset(struct peer *);
1616
1617 extern int peer_weight_set(struct peer *, afi_t, safi_t, uint16_t);
1618 extern int peer_weight_unset(struct peer *, afi_t, safi_t);
1619
1620 extern int peer_timers_set(struct peer *, uint32_t keepalive,
1621                            uint32_t holdtime);
1622 extern int peer_timers_unset(struct peer *);
1623
1624 extern int peer_timers_connect_set(struct peer *, uint32_t);
1625 extern int peer_timers_connect_unset(struct peer *);
1626
1627 extern int peer_advertise_interval_set(struct peer *, uint32_t);
1628 extern int peer_advertise_interval_unset(struct peer *);
1629
1630 extern void peer_interface_set(struct peer *, const char *);
1631 extern void peer_interface_unset(struct peer *);
1632
1633 extern int peer_distribute_set(struct peer *, afi_t, safi_t, int, const char *);
1634 extern int peer_distribute_unset(struct peer *, afi_t, safi_t, int);
1635
1636 extern int peer_allowas_in_set(struct peer *, afi_t, safi_t, int, int);
1637 extern int peer_allowas_in_unset(struct peer *, afi_t, safi_t);
1638
1639 extern int peer_local_as_set(struct peer *, as_t, int, int);
1640 extern int peer_local_as_unset(struct peer *);
1641
1642 extern int peer_prefix_list_set(struct peer *, afi_t, safi_t, int,
1643                                 const char *);
1644 extern int peer_prefix_list_unset(struct peer *, afi_t, safi_t, int);
1645
1646 extern int peer_aslist_set(struct peer *, afi_t, safi_t, int, const char *);
1647 extern int peer_aslist_unset(struct peer *, afi_t, safi_t, int);
1648
1649 extern int peer_route_map_set(struct peer *, afi_t, safi_t, int, const char *);
1650 extern int peer_route_map_unset(struct peer *, afi_t, safi_t, int);
1651
1652 extern int peer_unsuppress_map_set(struct peer *, afi_t, safi_t, const char *);
1653
1654 extern int peer_password_set(struct peer *, const char *);
1655 extern int peer_password_unset(struct peer *);
1656
1657 extern int peer_unsuppress_map_unset(struct peer *, afi_t, safi_t);
1658
1659 extern int peer_maximum_prefix_set(struct peer *, afi_t, safi_t, uint32_t,
1660                                    uint8_t, int, uint16_t);
1661 extern int peer_maximum_prefix_unset(struct peer *, afi_t, safi_t);
1662
1663 extern int peer_clear(struct peer *, struct listnode **);
1664 extern int peer_clear_soft(struct peer *, afi_t, safi_t, enum bgp_clear_type);
1665
1666 extern int peer_ttl_security_hops_set(struct peer *, int);
1667 extern int peer_ttl_security_hops_unset(struct peer *);
1668
1669 extern int peer_tx_shutdown_message_set(struct peer *, const char *msg);
1670 extern int peer_tx_shutdown_message_unset(struct peer *);
1671
1672 extern int bgp_route_map_update_timer(struct thread *thread);
1673 extern void bgp_route_map_terminate(void);
1674
1675 extern int peer_cmp(struct peer *p1, struct peer *p2);
1676
1677 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi, iana_safi_t pkt_safi,
1678                                      afi_t *afi, safi_t *safi);
1679 extern int bgp_map_afi_safi_int2iana(afi_t afi, safi_t safi,
1680                                      iana_afi_t *pkt_afi,
1681                                      iana_safi_t *pkt_safi);
1682
1683 extern struct peer_af *peer_af_create(struct peer *, afi_t, safi_t);
1684 extern struct peer_af *peer_af_find(struct peer *, afi_t, safi_t);
1685 extern int peer_af_delete(struct peer *, afi_t, safi_t);
1686
1687 extern void bgp_close(void);
1688 extern void bgp_free(struct bgp *);
1689
1690 static inline struct bgp *bgp_lock(struct bgp *bgp)
1691 {
1692         bgp->lock++;
1693         return bgp;
1694 }
1695
1696 static inline void bgp_unlock(struct bgp *bgp)
1697 {
1698         assert(bgp->lock > 0);
1699         if (--bgp->lock == 0)
1700                 bgp_free(bgp);
1701 }
1702
1703 static inline int afindex(afi_t afi, safi_t safi)
1704 {
1705         switch (afi) {
1706         case AFI_IP:
1707                 switch (safi) {
1708                 case SAFI_UNICAST:
1709                         return BGP_AF_IPV4_UNICAST;
1710                         break;
1711                 case SAFI_MULTICAST:
1712                         return BGP_AF_IPV4_MULTICAST;
1713                         break;
1714                 case SAFI_LABELED_UNICAST:
1715                         return BGP_AF_IPV4_LBL_UNICAST;
1716                         break;
1717                 case SAFI_MPLS_VPN:
1718                         return BGP_AF_IPV4_VPN;
1719                         break;
1720                 case SAFI_ENCAP:
1721                         return BGP_AF_IPV4_ENCAP;
1722                         break;
1723                 case SAFI_FLOWSPEC:
1724                         return BGP_AF_IPV4_FLOWSPEC;
1725                 default:
1726                         return BGP_AF_MAX;
1727                         break;
1728                 }
1729                 break;
1730         case AFI_IP6:
1731                 switch (safi) {
1732                 case SAFI_UNICAST:
1733                         return BGP_AF_IPV6_UNICAST;
1734                         break;
1735                 case SAFI_MULTICAST:
1736                         return BGP_AF_IPV6_MULTICAST;
1737                         break;
1738                 case SAFI_LABELED_UNICAST:
1739                         return BGP_AF_IPV6_LBL_UNICAST;
1740                         break;
1741                 case SAFI_MPLS_VPN:
1742                         return BGP_AF_IPV6_VPN;
1743                         break;
1744                 case SAFI_ENCAP:
1745                         return BGP_AF_IPV6_ENCAP;
1746                         break;
1747                 case SAFI_FLOWSPEC:
1748                         return BGP_AF_IPV6_FLOWSPEC;
1749                 default:
1750                         return BGP_AF_MAX;
1751                         break;
1752                 }
1753                 break;
1754         case AFI_L2VPN:
1755                 switch (safi) {
1756                 case SAFI_EVPN:
1757                         return BGP_AF_L2VPN_EVPN;
1758                         break;
1759                 default:
1760                         return BGP_AF_MAX;
1761                         break;
1762                 }
1763         default:
1764                 return BGP_AF_MAX;
1765                 break;
1766         }
1767 }
1768
1769 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
1770 static inline int peer_group_active(struct peer *peer)
1771 {
1772         if (!CHECK_FLAG(peer->sflags, PEER_STATUS_GROUP) && peer->group)
1773                 return 1;
1774         return 0;
1775 }
1776
1777 /* If peer is negotiated at least one address family return 1. */
1778 static inline int peer_afi_active_nego(const struct peer *peer, afi_t afi)
1779 {
1780         if (peer->afc_nego[afi][SAFI_UNICAST]
1781             || peer->afc_nego[afi][SAFI_MULTICAST]
1782             || peer->afc_nego[afi][SAFI_LABELED_UNICAST]
1783             || peer->afc_nego[afi][SAFI_MPLS_VPN]
1784             || peer->afc_nego[afi][SAFI_ENCAP]
1785             || peer->afc_nego[afi][SAFI_FLOWSPEC]
1786             || peer->afc_nego[afi][SAFI_EVPN])
1787                 return 1;
1788         return 0;
1789 }
1790
1791 /* If at least one address family activated for group, return 1. */
1792 static inline int peer_group_af_configured(struct peer_group *group)
1793 {
1794         struct peer *peer = group->conf;
1795
1796         if (peer->afc[AFI_IP][SAFI_UNICAST] || peer->afc[AFI_IP][SAFI_MULTICAST]
1797             || peer->afc[AFI_IP][SAFI_LABELED_UNICAST]
1798             || peer->afc[AFI_IP][SAFI_FLOWSPEC]
1799             || peer->afc[AFI_IP][SAFI_MPLS_VPN] || peer->afc[AFI_IP][SAFI_ENCAP]
1800             || peer->afc[AFI_IP6][SAFI_UNICAST]
1801             || peer->afc[AFI_IP6][SAFI_MULTICAST]
1802             || peer->afc[AFI_IP6][SAFI_LABELED_UNICAST]
1803             || peer->afc[AFI_IP6][SAFI_MPLS_VPN]
1804             || peer->afc[AFI_IP6][SAFI_ENCAP]
1805             || peer->afc[AFI_IP6][SAFI_FLOWSPEC]
1806             || peer->afc[AFI_L2VPN][SAFI_EVPN])
1807                 return 1;
1808         return 0;
1809 }
1810
1811 static inline char *timestamp_string(time_t ts)
1812 {
1813         time_t tbuf;
1814         tbuf = time(NULL) - (bgp_clock() - ts);
1815         return ctime(&tbuf);
1816 }
1817
1818 static inline int peer_established(struct peer *peer)
1819 {
1820         if (peer->status == Established)
1821                 return 1;
1822         return 0;
1823 }
1824
1825 static inline int peer_dynamic_neighbor(struct peer *peer)
1826 {
1827         return (CHECK_FLAG(peer->flags, PEER_FLAG_DYNAMIC_NEIGHBOR)) ? 1 : 0;
1828 }
1829
1830 static inline int peer_cap_enhe(struct peer *peer, afi_t afi, safi_t safi)
1831 {
1832         return (CHECK_FLAG(peer->af_cap[afi][safi], PEER_CAP_ENHE_AF_NEGO));
1833 }
1834
1835 /* Lookup VRF for BGP instance based on its type. */
1836 static inline struct vrf *bgp_vrf_lookup_by_instance_type(struct bgp *bgp)
1837 {
1838         struct vrf *vrf;
1839
1840         if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT)
1841                 vrf = vrf_lookup_by_id(VRF_DEFAULT);
1842         else if (bgp->inst_type == BGP_INSTANCE_TYPE_VRF)
1843                 vrf = vrf_lookup_by_name(bgp->name);
1844         else
1845                 vrf = NULL;
1846
1847         return vrf;
1848 }
1849
1850 /* Link BGP instance to VRF. */
1851 static inline void bgp_vrf_link(struct bgp *bgp, struct vrf *vrf)
1852 {
1853         bgp->vrf_id = vrf->vrf_id;
1854         if (vrf->info != (void *)bgp)
1855                 vrf->info = (void *)bgp_lock(bgp);
1856 }
1857
1858 /* Unlink BGP instance from VRF. */
1859 static inline void bgp_vrf_unlink(struct bgp *bgp, struct vrf *vrf)
1860 {
1861         if (vrf->info == (void *)bgp) {
1862                 vrf->info = NULL;
1863                 bgp_unlock(bgp);
1864         }
1865         bgp->vrf_id = VRF_UNKNOWN;
1866 }
1867
1868 extern void bgp_update_redist_vrf_bitmaps(struct bgp *, vrf_id_t);
1869
1870 /* For benefit of rfapi */
1871 extern struct peer *peer_new(struct bgp *bgp);
1872
1873 #endif /* _QUAGGA_BGPD_H */