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