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