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