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