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