proto/bgp/bgp.h

   1 /*
   2  *      BIRD -- The Border Gateway Protocol
   3  *
   4  *      (c) 2000 Martin Mares <mj@ucw.cz>
   5  *      (c) 2008--2016 Ondrej Zajicek <santiago@crfreenet.org>
   6  *      (c) 2008--2016 CZ.NIC z.s.p.o.
   7  *
   8  *      Can be freely distributed and used under the terms of the GNU GPL.
   9  */
  10
  11 #ifndef _BIRD_BGP_H_
  12 #define _BIRD_BGP_H_
  13
  14 #include <stdint.h>
  15 #include <setjmp.h>
  16 #include "nest/bird.h"
  17 #include "nest/route.h"
  18 #include "nest/bfd.h"
  19 //#include "lib/lists.h"
  20 #include "lib/hash.h"
  21 #include "lib/socket.h"
  22
  23 struct linpool;
  24 struct eattr;
  25
  26
  27 /* Address families */
  28
  29 #define BGP_AFI_IPV4            1
  30 #define BGP_AFI_IPV6            2
  31
  32 #define BGP_SAFI_UNICAST        1
  33 #define BGP_SAFI_MULTICAST      2
  34 #define BGP_SAFI_MPLS           4
  35 #define BGP_SAFI_MPLS_VPN       128
  36 #define BGP_SAFI_VPN_MULTICAST  129
  37 #define BGP_SAFI_FLOW           133
  38
  39 /* Internal AF codes */
  40
  41 #define BGP_AF(A, B)            (((u32)(A) << 16) | (u32)(B))
  42 #define BGP_AFI(A)              ((u32)(A) >> 16)
  43 #define BGP_SAFI(A)             ((u32)(A) & 0xFFFF)
  44
  45 #define BGP_AF_IPV4             BGP_AF( BGP_AFI_IPV4, BGP_SAFI_UNICAST )
  46 #define BGP_AF_IPV6             BGP_AF( BGP_AFI_IPV6, BGP_SAFI_UNICAST )
  47 #define BGP_AF_IPV4_MC          BGP_AF( BGP_AFI_IPV4, BGP_SAFI_MULTICAST )
  48 #define BGP_AF_IPV6_MC          BGP_AF( BGP_AFI_IPV6, BGP_SAFI_MULTICAST )
  49 #define BGP_AF_IPV4_MPLS        BGP_AF( BGP_AFI_IPV4, BGP_SAFI_MPLS )
  50 #define BGP_AF_IPV6_MPLS        BGP_AF( BGP_AFI_IPV6, BGP_SAFI_MPLS )
  51 #define BGP_AF_VPN4_MPLS        BGP_AF( BGP_AFI_IPV4, BGP_SAFI_MPLS_VPN )
  52 #define BGP_AF_VPN6_MPLS        BGP_AF( BGP_AFI_IPV6, BGP_SAFI_MPLS_VPN )
  53 #define BGP_AF_VPN4_MC          BGP_AF( BGP_AFI_IPV4, BGP_SAFI_VPN_MULTICAST )
  54 #define BGP_AF_VPN6_MC          BGP_AF( BGP_AFI_IPV6, BGP_SAFI_VPN_MULTICAST )
  55 #define BGP_AF_FLOW4            BGP_AF( BGP_AFI_IPV4, BGP_SAFI_FLOW )
  56 #define BGP_AF_FLOW6            BGP_AF( BGP_AFI_IPV6, BGP_SAFI_FLOW )
  57
  58
  59 struct bgp_write_state;
  60 struct bgp_parse_state;
  61 struct bgp_export_state;
  62 struct bgp_bucket;
  63
  64 struct bgp_af_desc {
  65   u32 afi;
  66   u32 net;
  67   u8 mpls;
  68   u8 no_igp;
  69   const char *name;
  70   uint (*encode_nlri)(struct bgp_write_state *s, struct bgp_bucket *buck, byte *buf, uint size);
  71   void (*decode_nlri)(struct bgp_parse_state *s, byte *pos, uint len, rta *a);
  72   void (*update_next_hop)(struct bgp_export_state *s, eattr *nh, ea_list **to);
  73   uint (*encode_next_hop)(struct bgp_write_state *s, eattr *nh, byte *buf, uint size);
  74   void (*decode_next_hop)(struct bgp_parse_state *s, byte *pos, uint len, rta *a);
  75 };
  76
  77
  78 struct bgp_config {
  79   struct proto_config c;
  80   u32 local_as, remote_as;
  81   ip_addr local_ip;                     /* Source address to use */
  82   ip_addr remote_ip;
  83   struct iface *iface;                  /* Interface for link-local addresses */
  84   u16 local_port;                       /* Local listening port */
  85   u16 remote_port;                      /* Neighbor destination port */
  86   int multihop;                         /* Number of hops if multihop */
  87   int strict_bind;                      /* Bind listening socket to local address */
  88   int ttl_security;                     /* Enable TTL security [RFC 5082] */
  89   int compare_path_lengths;             /* Use path lengths when selecting best route */
  90   int med_metric;                       /* Compare MULTI_EXIT_DISC even between routes from differen ASes */
  91   int igp_metric;                       /* Use IGP metrics when selecting best route */
  92   int prefer_older;                     /* Prefer older routes according to RFC 5004 */
  93   int deterministic_med;                /* Use more complicated algo to have strict RFC 4271 MED comparison */
  94   u32 default_local_pref;               /* Default value for LOCAL_PREF attribute */
  95   u32 default_med;                      /* Default value for MULTI_EXIT_DISC attribute */
  96   int capabilities;                     /* Enable capability handshake [RFC 5492] */
  97   int enable_refresh;                   /* Enable local support for route refresh [RFC 2918] */
  98   int enable_as4;                       /* Enable local support for 4B AS numbers [RFC 6793] */
  99   int enable_extended_messages;         /* Enable local support for extended messages [draft] */
 100   u32 rr_cluster_id;                    /* Route reflector cluster ID, if different from local ID */
 101   int rr_client;                        /* Whether neighbor is RR client of me */
 102   int rs_client;                        /* Whether neighbor is RS client of me */
 103   u32 confederation;                    /* Confederation ID, or zero if confeds not active */
 104   int confederation_member;             /* Whether neighbor AS is member of our confederation */
 105   int passive;                          /* Do not initiate outgoing connection */
 106   int interpret_communities;            /* Hardwired handling of well-known communities */
 107   int allow_local_as;                   /* Allow that number of local ASNs in incoming AS_PATHs */
 108   int allow_local_pref;                 /* Allow LOCAL_PREF in EBGP sessions */
 109   int gr_mode;                          /* Graceful restart mode (BGP_GR_*) */
 110   int llgr_mode;                        /* Long-lived graceful restart mode (BGP_LLGR_*) */
 111   int setkey;                           /* Set MD5 password to system SA/SP database */
 112   /* Times below are in seconds */
 113   unsigned gr_time;                     /* Graceful restart timeout */
 114   unsigned llgr_time;                   /* Long-lived graceful restart stale time */
 115   unsigned connect_delay_time;          /* Minimum delay between connect attempts */
 116   unsigned connect_retry_time;          /* Timeout for connect attempts */
 117   unsigned hold_time, initial_hold_time;
 118   unsigned keepalive_time;
 119   unsigned error_amnesia_time;          /* Errors are forgotten after */
 120   unsigned error_delay_time_min;        /* Time to wait after an error is detected */
 121   unsigned error_delay_time_max;
 122   unsigned disable_after_error;         /* Disable the protocol when error is detected */
 123   u32 disable_after_cease;              /* Disable it when cease is received, bitfield */
 124
 125   char *password;                       /* Password used for MD5 authentication */
 126   int check_link;                       /* Use iface link state for liveness detection */
 127   int bfd;                              /* Use BFD for liveness detection */
 128 };
 129
 130 struct bgp_channel_config {
 131   struct channel_config c;
 132
 133   u32 afi;
 134   const struct bgp_af_desc *desc;
 135
 136   ip_addr next_hop_addr;                /* Local address for NEXT_HOP attribute */
 137   u8 next_hop_self;                     /* Always set next hop to local IP address (NH_*) */
 138   u8 next_hop_keep;                     /* Do not modify next hop attribute (NH_*) */
 139   u8 mandatory;                         /* Channel is mandatory in capability negotiation */
 140   u8 missing_lladdr;                    /* What we will do when we don' know link-local addr, see MLL_* */
 141   u8 gw_mode;                           /* How we compute route gateway from next_hop attr, see GW_* */
 142   u8 secondary;                         /* Accept also non-best routes (i.e. RA_ACCEPTED) */
 143   u8 gr_able;                           /* Allow full graceful restart for the channel */
 144   u8 llgr_able;                         /* Allow full long-lived GR for the channel */
 145   uint llgr_time;                       /* Long-lived graceful restart stale time */
 146   u8 ext_next_hop;                      /* Allow both IPv4 and IPv6 next hops */
 147   u8 add_path;                          /* Use ADD-PATH extension [RFC 7911] */
 148   u8 import_table;                      /* Use c.in_table as Adj-RIB-In */
 149
 150   uint rest[0];                         /* Remaining items are reconfigured separately */
 151   struct rtable_config *igp_table_ip4;  /* Table for recursive IPv4 next hop lookups */
 152   struct rtable_config *igp_table_ip6;  /* Table for recursive IPv6 next hop lookups */
 153 };
 154
 155 #define NH_NO                   0
 156 #define NH_ALL                  1
 157 #define NH_IBGP                 2
 158 #define NH_EBGP                 3
 159
 160 #define MLL_SELF                1
 161 #define MLL_DROP                2
 162 #define MLL_IGNORE              3
 163
 164 #define GW_DIRECT               1
 165 #define GW_RECURSIVE            2
 166
 167 #define BGP_ADD_PATH_RX         1
 168 #define BGP_ADD_PATH_TX         2
 169 #define BGP_ADD_PATH_FULL       3
 170
 171 #define BGP_GR_ABLE             1
 172 #define BGP_GR_AWARE            2
 173
 174 /* For GR capability common flags */
 175 #define BGP_GRF_RESTART 0x80
 176
 177 /* For GR capability per-AF flags */
 178 #define BGP_GRF_FORWARDING 0x80
 179
 180 #define BGP_LLGR_ABLE           1
 181 #define BGP_LLGR_AWARE          2
 182
 183 #define BGP_LLGRF_FORWARDING 0x80
 184
 185 #define BGP_GRS_NONE            0       /* No GR  */
 186 #define BGP_GRS_ACTIVE          1       /* Graceful restart per RFC 4724 */
 187 #define BGP_GRS_LLGR            2       /* Long-lived GR phase (stale timer active) */
 188
 189 #define BGP_BFD_GRACEFUL        2       /* BFD down triggers graceful restart */
 190
 191
 192 struct bgp_af_caps {
 193   u32 afi;
 194   u8 ready;                             /* Multiprotocol capability, RFC 4760 */
 195   u8 gr_able;                           /* Graceful restart support, RFC 4724 */
 196   u8 gr_af_flags;                       /* Graceful restart per-AF flags */
 197   u8 llgr_able;                         /* Long-lived GR, RFC draft */
 198   u32 llgr_time;                        /* Long-lived GR stale time */
 199   u8 llgr_flags;                        /* Long-lived GR per-AF flags */
 200   u8 ext_next_hop;                      /* Extended IPv6 next hop,   RFC 5549 */
 201   u8 add_path;                          /* Multiple paths support,   RFC 7911 */
 202 };
 203
 204 struct bgp_caps {
 205   u32 as4_number;                       /* Announced ASN */
 206
 207   u8 as4_support;                       /* Four-octet AS capability, RFC 6793 */
 208   u8 ext_messages;                      /* Extended message length,  RFC draft */
 209   u8 route_refresh;                     /* Route refresh capability, RFC 2918 */
 210   u8 enhanced_refresh;                  /* Enhanced route refresh,   RFC 7313 */
 211
 212   u8 gr_aware;                          /* Graceful restart capability, RFC 4724 */
 213   u8 gr_flags;                          /* Graceful restart flags */
 214   u16 gr_time;                          /* Graceful restart time in seconds */
 215
 216   u8 llgr_aware;                        /* Long-lived GR capability, RFC draft */
 217
 218   u16 af_count;                         /* Number of af_data items */
 219   u16 length;                           /* Length of capabilities in OPEN msg */
 220
 221   struct bgp_af_caps af_data[0];        /* Per-AF capability data */
 222 };
 223
 224 #define WALK_AF_CAPS(caps,ac) \
 225   for (ac = caps->af_data; ac < &caps->af_data[caps->af_count]; ac++)
 226
 227
 228 struct bgp_socket {
 229   node n;                               /* Node in global bgp_sockets */
 230   sock *sk;                             /* Real listening socket */
 231   u32 uc;                               /* Use count */
 232 };
 233
 234 struct bgp_conn {
 235   struct bgp_proto *bgp;
 236   struct birdsock *sk;
 237   u8 state;                             /* State of connection state machine */
 238   u8 as4_session;                       /* Session uses 4B AS numbers in AS_PATH (both sides support it) */
 239   u8 ext_messages;                      /* Session uses extended message length */
 240
 241   struct bgp_caps *local_caps;
 242   struct bgp_caps *remote_caps;
 243   timer *connect_timer;
 244   timer *hold_timer;
 245   timer *keepalive_timer;
 246   event *tx_ev;
 247   u32 packets_to_send;                  /* Bitmap of packet types to be sent */
 248   u32 channels_to_send;                 /* Bitmap of channels with packets to be sent */
 249   u8 last_channel;                      /* Channel used last time for TX */
 250   u8 last_channel_count;                /* Number of times the last channel was used in succession */
 251   int notify_code, notify_subcode, notify_size;
 252   byte *notify_data;
 253
 254   uint hold_time, keepalive_time;       /* Times calculated from my and neighbor's requirements */
 255 };
 256
 257 struct bgp_proto {
 258   struct proto p;
 259   struct bgp_config *cf;                /* Shortcut to BGP configuration */
 260   u32 local_as, remote_as;
 261   u32 public_as;                        /* Externally visible ASN (local_as or confederation id) */
 262   u32 local_id;                         /* BGP identifier of this router */
 263   u32 remote_id;                        /* BGP identifier of the neighbor */
 264   u32 rr_cluster_id;                    /* Route reflector cluster ID */
 265   int start_state;                      /* Substates that partitions BS_START */
 266   u8 is_internal;                       /* Internal BGP session (local_as == remote_as) */
 267   u8 is_interior;                       /* Internal or intra-confederation BGP session */
 268   u8 as4_session;                       /* Session uses 4B AS numbers in AS_PATH (both sides support it) */
 269   u8 rr_client;                         /* Whether neighbor is RR client of me */
 270   u8 rs_client;                         /* Whether neighbor is RS client of me */
 271   u8 route_refresh;                     /* Route refresh allowed to send [RFC 2918] */
 272   u8 enhanced_refresh;                  /* Enhanced refresh is negotiated [RFC 7313] */
 273   u8 gr_ready;                          /* Neighbor could do graceful restart */
 274   u8 llgr_ready;                        /* Neighbor could do Long-lived GR, implies gr_ready */
 275   u8 gr_active_num;                     /* Neighbor is doing GR, number of active channels */
 276   u8 channel_count;                     /* Number of active channels */
 277   u8 summary_add_path_rx;               /* Summary state of ADD_PATH RX w.r.t active channels */
 278   u32 *afi_map;                         /* Map channel index -> AFI */
 279   struct bgp_channel **channel_map;     /* Map channel index -> channel */
 280   struct bgp_conn *conn;                /* Connection we have established */
 281   struct bgp_conn outgoing_conn;        /* Outgoing connection we're working with */
 282   struct bgp_conn incoming_conn;        /* Incoming connection we have neither accepted nor rejected yet */
 283   struct object_lock *lock;             /* Lock for neighbor connection */
 284   struct neighbor *neigh;               /* Neighbor entry corresponding to remote ip, NULL if multihop */
 285   struct bgp_socket *sock;              /* Shared listening socket */
 286   struct bfd_request *bfd_req;          /* BFD request, if BFD is used */
 287   ip_addr source_addr;                  /* Local address used as an advertised next hop */
 288   ip_addr link_addr;                    /* Link-local version of source_addr */
 289   event *event;                         /* Event for respawning and shutting process */
 290   timer *startup_timer;                 /* Timer used to delay protocol startup due to previous errors (startup_delay) */
 291   timer *gr_timer;                      /* Timer waiting for reestablishment after graceful restart */
 292   uint startup_delay;                   /* Delay (in seconds) of protocol startup due to previous errors */
 293   btime last_proto_error;               /* Time of last error that leads to protocol stop */
 294   u8 last_error_class;                  /* Error class of last error */
 295   u32 last_error_code;                  /* Error code of last error. BGP protocol errors
 296                                            are encoded as (bgp_err_code << 16 | bgp_err_subcode) */
 297 };
 298
 299 struct bgp_channel {
 300   struct channel c;
 301
 302   /* Rest are BGP specific data */
 303   struct bgp_channel_config *cf;
 304
 305   u32 afi;
 306   u32 index;
 307   const struct bgp_af_desc *desc;
 308
 309   rtable *igp_table_ip4;                /* Table for recursive IPv4 next hop lookups */
 310   rtable *igp_table_ip6;                /* Table for recursive IPv6 next hop lookups */
 311
 312   /* Rest are zeroed when down */
 313   pool *pool;
 314   HASH(struct bgp_bucket) bucket_hash;  /* Hash table of route buckets */
 315   struct bgp_bucket *withdraw_bucket;   /* Withdrawn routes */
 316   list bucket_queue;                    /* Queue of buckets to send (struct bgp_bucket) */
 317
 318   HASH(struct bgp_prefix) prefix_hash;  /* Prefixes to be sent */
 319   slab *prefix_slab;                    /* Slab holding prefix nodes */
 320
 321   ip_addr next_hop_addr;                /* Local address for NEXT_HOP attribute */
 322   ip_addr link_addr;                    /* Link-local version of next_hop_addr */
 323
 324   u32 packets_to_send;                  /* Bitmap of packet types to be sent */
 325
 326   u8 ext_next_hop;                      /* Session allows both IPv4 and IPv6 next hops */
 327
 328   u8 gr_ready;                          /* Neighbor could do GR on this AF */
 329   u8 gr_active;                         /* Neighbor is doing GR (BGP_GRS_*) */
 330
 331   timer *stale_timer;                   /* Long-lived stale timer for LLGR */
 332   u32 stale_time;                       /* Stored LLGR stale time from last session */
 333
 334   u8 add_path_rx;                       /* Session expects receive of ADD-PATH extended NLRI */
 335   u8 add_path_tx;                       /* Session expects transmit of ADD-PATH extended NLRI */
 336
 337   u8 feed_state;                        /* Feed state (TX) for EoR, RR packets, see BFS_* */
 338   u8 load_state;                        /* Load state (RX) for EoR, RR packets, see BFS_* */
 339 };
 340
 341 struct bgp_prefix {
 342   node buck_node;                       /* Node in per-bucket list */
 343   struct bgp_prefix *next;              /* Node in prefix hash table */
 344   u32 hash;
 345   u32 path_id;
 346   net_addr net[0];
 347 };
 348
 349 struct bgp_bucket {
 350   node send_node;                       /* Node in send queue */
 351   struct bgp_bucket *next;              /* Node in bucket hash table */
 352   list prefixes;                        /* Prefixes in this bucket (struct bgp_prefix) */
 353   u32 hash;                             /* Hash over extended attributes */
 354   ea_list eattrs[0];                    /* Per-bucket extended attributes */
 355 };
 356
 357 struct bgp_export_state {
 358   struct bgp_proto *proto;
 359   struct bgp_channel *channel;
 360   struct linpool *pool;
 361
 362   struct bgp_proto *src;
 363   rte *route;
 364   int mpls;
 365
 366   u32 attrs_seen[1];
 367   uint err_withdraw;
 368 };
 369
 370 struct bgp_write_state {
 371   struct bgp_proto *proto;
 372   struct bgp_channel *channel;
 373   struct linpool *pool;
 374
 375   int mp_reach;
 376   int as4_session;
 377   int add_path;
 378   int mpls;
 379
 380   eattr *mp_next_hop;
 381   adata *mpls_labels;
 382 };
 383
 384 struct bgp_parse_state {
 385   struct bgp_proto *proto;
 386   struct bgp_channel *channel;
 387   struct linpool *pool;
 388
 389   int as4_session;
 390   int add_path;
 391   int mpls;
 392
 393   u32 attrs_seen[256/32];
 394
 395   u32 mp_reach_af;
 396   u32 mp_unreach_af;
 397
 398   uint attr_len;
 399   uint ip_reach_len;
 400   uint ip_unreach_len;
 401   uint ip_next_hop_len;
 402   uint mp_reach_len;
 403   uint mp_unreach_len;
 404   uint mp_next_hop_len;
 405
 406   byte *attrs;
 407   byte *ip_reach_nlri;
 408   byte *ip_unreach_nlri;
 409   byte *ip_next_hop_data;
 410   byte *mp_reach_nlri;
 411   byte *mp_unreach_nlri;
 412   byte *mp_next_hop_data;
 413
 414   uint err_withdraw;
 415   uint err_subcode;
 416   jmp_buf err_jmpbuf;
 417
 418   struct hostentry *hostentry;
 419   adata *mpls_labels;
 420
 421   /* Cached state for bgp_rte_update() */
 422   u32 last_id;
 423   struct rte_src *last_src;
 424   rta *cached_rta;
 425 };
 426
 427 #define BGP_PORT                179
 428 #define BGP_VERSION             4
 429 #define BGP_HEADER_LENGTH       19
 430 #define BGP_MAX_MESSAGE_LENGTH  4096
 431 #define BGP_MAX_EXT_MSG_LENGTH  65535
 432 #define BGP_RX_BUFFER_SIZE      4096
 433 #define BGP_TX_BUFFER_SIZE      4096
 434 #define BGP_RX_BUFFER_EXT_SIZE  65535
 435 #define BGP_TX_BUFFER_EXT_SIZE  65535
 436
 437 static inline int bgp_channel_is_ipv4(struct bgp_channel *c)
 438 { return BGP_AFI(c->afi) == BGP_AFI_IPV4; }
 439
 440 static inline int bgp_channel_is_ipv6(struct bgp_channel *c)
 441 { return BGP_AFI(c->afi) == BGP_AFI_IPV6; }
 442
 443 static inline int bgp_cc_is_ipv4(struct bgp_channel_config *c)
 444 { return BGP_AFI(c->afi) == BGP_AFI_IPV4; }
 445
 446 static inline int bgp_cc_is_ipv6(struct bgp_channel_config *c)
 447 { return BGP_AFI(c->afi) == BGP_AFI_IPV6; }
 448
 449 static inline uint bgp_max_packet_length(struct bgp_conn *conn)
 450 { return conn->ext_messages ? BGP_MAX_EXT_MSG_LENGTH : BGP_MAX_MESSAGE_LENGTH; }
 451
 452 static inline void
 453 bgp_parse_error(struct bgp_parse_state *s, uint subcode)
 454 {
 455   s->err_subcode = subcode;
 456   longjmp(s->err_jmpbuf, 1);
 457 }
 458
 459 extern struct linpool *bgp_linpool;
 460 extern struct linpool *bgp_linpool2;
 461
 462
 463 void bgp_start_timer(timer *t, uint value);
 464 void bgp_check_config(struct bgp_config *c);
 465 void bgp_error(struct bgp_conn *c, unsigned code, unsigned subcode, byte *data, int len);
 466 void bgp_close_conn(struct bgp_conn *c);
 467 void bgp_update_startup_delay(struct bgp_proto *p);
 468 void bgp_conn_enter_openconfirm_state(struct bgp_conn *conn);
 469 void bgp_conn_enter_established_state(struct bgp_conn *conn);
 470 void bgp_conn_enter_close_state(struct bgp_conn *conn);
 471 void bgp_conn_enter_idle_state(struct bgp_conn *conn);
 472 void bgp_handle_graceful_restart(struct bgp_proto *p);
 473 void bgp_graceful_restart_done(struct bgp_channel *c);
 474 void bgp_refresh_begin(struct bgp_channel *c);
 475 void bgp_refresh_end(struct bgp_channel *c);
 476 void bgp_store_error(struct bgp_proto *p, struct bgp_conn *c, u8 class, u32 code);
 477 void bgp_stop(struct bgp_proto *p, uint subcode, byte *data, uint len);
 478
 479 struct rte_source *bgp_find_source(struct bgp_proto *p, u32 path_id);
 480 struct rte_source *bgp_get_source(struct bgp_proto *p, u32 path_id);
 481
 482
 483
 484 #ifdef LOCAL_DEBUG
 485 #define BGP_FORCE_DEBUG 1
 486 #else
 487 #define BGP_FORCE_DEBUG 0
 488 #endif
 489 #define BGP_TRACE(flags, msg, args...) do { if ((p->p.debug & flags) || BGP_FORCE_DEBUG) \
 490         log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
 491
 492 #define BGP_TRACE_RL(rl, flags, msg, args...) do { if ((p->p.debug & flags) || BGP_FORCE_DEBUG) \
 493         log_rl(rl, L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
 494
 495
 496 /* attrs.c */
 497
 498 static inline eattr *
 499 bgp_find_attr(ea_list *attrs, uint code)
 500 {
 501   return ea_find(attrs, EA_CODE(PROTOCOL_BGP, code));
 502 }
 503
 504 eattr *
 505 bgp_set_attr(ea_list **attrs, struct linpool *pool, uint code, uint flags, uintptr_t val);
 506
 507 static inline void
 508 bgp_set_attr_u32(ea_list **to, struct linpool *pool, uint code, uint flags, u32 val)
 509 { bgp_set_attr(to, pool, code, flags, (uintptr_t) val); }
 510
 511 static inline void
 512 bgp_set_attr_ptr(ea_list **to, struct linpool *pool, uint code, uint flags, struct adata *val)
 513 { bgp_set_attr(to, pool, code, flags, (uintptr_t) val); }
 514
 515 static inline void
 516 bgp_set_attr_data(ea_list **to, struct linpool *pool, uint code, uint flags, void *data, uint len)
 517 {
 518   struct adata *a = lp_alloc_adata(pool, len);
 519   memcpy(a->data, data, len);
 520   bgp_set_attr(to, pool, code, flags, (uintptr_t) a);
 521 }
 522
 523 static inline void
 524 bgp_unset_attr(ea_list **to, struct linpool *pool, uint code)
 525 { eattr *e = bgp_set_attr(to, pool, code, 0, 0); e->type = EAF_TYPE_UNDEF; }
 526
 527
 528 int bgp_encode_attrs(struct bgp_write_state *s, ea_list *attrs, byte *buf, byte *end);
 529 ea_list * bgp_decode_attrs(struct bgp_parse_state *s, byte *data, uint len);
 530
 531 void bgp_init_bucket_table(struct bgp_channel *c);
 532 void bgp_free_bucket_table(struct bgp_channel *c);
 533 void bgp_free_bucket(struct bgp_channel *c, struct bgp_bucket *b);
 534 void bgp_defer_bucket(struct bgp_channel *c, struct bgp_bucket *b);
 535 void bgp_withdraw_bucket(struct bgp_channel *c, struct bgp_bucket *b);
 536
 537 void bgp_init_prefix_table(struct bgp_channel *c);
 538 void bgp_free_prefix_table(struct bgp_channel *c);
 539 void bgp_free_prefix(struct bgp_channel *c, struct bgp_prefix *bp);
 540
 541 int bgp_rte_better(struct rte *, struct rte *);
 542 int bgp_rte_mergable(rte *pri, rte *sec);
 543 int bgp_rte_recalculate(rtable *table, net *net, rte *new, rte *old, rte *old_best);
 544 struct rte *bgp_rte_modify_stale(struct rte *r, struct linpool *pool);
 545 void bgp_rt_notify(struct proto *P, struct channel *C, net *n, rte *new, rte *old);
 546 int bgp_preexport(struct proto *, struct rte **, struct linpool *);
 547 int bgp_get_attr(struct eattr *e, byte *buf, int buflen);
 548 void bgp_get_route_info(struct rte *, byte *buf);
 549
 550
 551 /* packets.c */
 552
 553 void bgp_dump_state_change(struct bgp_conn *conn, uint old, uint new);
 554 const struct bgp_af_desc *bgp_get_af_desc(u32 afi);
 555 const struct bgp_af_caps *bgp_find_af_caps(struct bgp_caps *caps, u32 afi);
 556 void bgp_schedule_packet(struct bgp_conn *conn, struct bgp_channel *c, int type);
 557 void bgp_kick_tx(void *vconn);
 558 void bgp_tx(struct birdsock *sk);
 559 int bgp_rx(struct birdsock *sk, uint size);
 560 const char * bgp_error_dsc(unsigned code, unsigned subcode);
 561 void bgp_log_error(struct bgp_proto *p, u8 class, char *msg, unsigned code, unsigned subcode, byte *data, unsigned len);
 562
 563 void bgp_update_next_hop(struct bgp_export_state *s, eattr *a, ea_list **to);
 564
 565
 566 /* Packet types */
 567
 568 #define PKT_OPEN                0x01
 569 #define PKT_UPDATE              0x02
 570 #define PKT_NOTIFICATION        0x03
 571 #define PKT_KEEPALIVE           0x04
 572 #define PKT_ROUTE_REFRESH       0x05    /* [RFC2918] */
 573 #define PKT_BEGIN_REFRESH       0x1e    /* Dummy type for BoRR packet [RFC7313] */
 574 #define PKT_SCHEDULE_CLOSE      0x1f    /* Used internally to schedule socket close */
 575
 576 /* Attributes */
 577
 578 #define BAF_OPTIONAL            0x80
 579 #define BAF_TRANSITIVE          0x40
 580 #define BAF_PARTIAL             0x20
 581 #define BAF_EXT_LEN             0x10
 582
 583 #define BA_ORIGIN               0x01    /* RFC 4271 */          /* WM */
 584 #define BA_AS_PATH              0x02                            /* WM */
 585 #define BA_NEXT_HOP             0x03                            /* WM */
 586 #define BA_MULTI_EXIT_DISC      0x04                            /* ON */
 587 #define BA_LOCAL_PREF           0x05                            /* WD */
 588 #define BA_ATOMIC_AGGR          0x06                            /* WD */
 589 #define BA_AGGREGATOR           0x07                            /* OT */
 590 #define BA_COMMUNITY            0x08    /* RFC 1997 */          /* OT */
 591 #define BA_ORIGINATOR_ID        0x09    /* RFC 4456 */          /* ON */
 592 #define BA_CLUSTER_LIST         0x0a    /* RFC 4456 */          /* ON */
 593 #define BA_MP_REACH_NLRI        0x0e    /* RFC 4760 */
 594 #define BA_MP_UNREACH_NLRI      0x0f    /* RFC 4760 */
 595 #define BA_EXT_COMMUNITY        0x10    /* RFC 4360 */
 596 #define BA_AS4_PATH             0x11    /* RFC 6793 */
 597 #define BA_AS4_AGGREGATOR       0x12    /* RFC 6793 */
 598 #define BA_LARGE_COMMUNITY      0x20    /* RFC 8092 */
 599
 600 /* Bird's private internal BGP attributes */
 601 #define BA_MPLS_LABEL_STACK     0xfe    /* MPLS label stack transfer attribute */
 602
 603 /* BGP connection states */
 604
 605 #define BS_IDLE                 0
 606 #define BS_CONNECT              1       /* Attempting to connect */
 607 #define BS_ACTIVE               2       /* Waiting for connection retry & listening */
 608 #define BS_OPENSENT             3
 609 #define BS_OPENCONFIRM          4
 610 #define BS_ESTABLISHED          5
 611 #define BS_CLOSE                6       /* Used during transition to BS_IDLE */
 612
 613 #define BS_MAX                  7
 614
 615 /* BGP start states
 616  *
 617  * Used in PS_START for fine-grained specification of starting state.
 618  *
 619  * When BGP protocol is started by core, it goes to BSS_PREPARE. When BGP
 620  * protocol done what is neccessary to start itself (like acquiring the lock),
 621  * it goes to BSS_CONNECT.
 622  */
 623
 624 #define BSS_PREPARE             0       /* Used before ordinary BGP started, i. e. waiting for lock */
 625 #define BSS_DELAY               1       /* Startup delay due to previous errors */
 626 #define BSS_CONNECT             2       /* Ordinary BGP connecting */
 627
 628
 629 /* BGP feed states (TX)
 630  *
 631  * RFC 4724 specifies that an initial feed should end with End-of-RIB mark.
 632  *
 633  * RFC 7313 specifies that a route refresh should be demarcated by BoRR and EoRR packets.
 634  *
 635  * These states (stored in c->feed_state) are used to keep track of these
 636  * requirements. When such feed is started, BFS_LOADING / BFS_REFRESHING is
 637  * set. When it ended, BFS_LOADED / BFS_REFRESHED is set to schedule End-of-RIB
 638  * or EoRR packet. When the packet is sent, the state returned to BFS_NONE.
 639  *
 640  * Note that when a non-demarcated feed (e.g. plain RFC 4271 initial load
 641  * without End-of-RIB or plain RFC 2918 route refresh without BoRR/EoRR
 642  * demarcation) is active, BFS_NONE is set.
 643  *
 644  * BFS_NONE, BFS_LOADING and BFS_REFRESHING are also used as load states (RX)
 645  * with correspondent semantics (-, expecting End-of-RIB, expecting EoRR).
 646  */
 647
 648 #define BFS_NONE                0       /* No feed or original non-demarcated feed */
 649 #define BFS_LOADING             1       /* Initial feed active, End-of-RIB planned */
 650 #define BFS_LOADED              2       /* Loading done, End-of-RIB marker scheduled */
 651 #define BFS_REFRESHING          3       /* Route refresh (introduced by BoRR) active */
 652 #define BFS_REFRESHED           4       /* Refresh done, EoRR packet scheduled */
 653
 654
 655 /* Error classes */
 656
 657 #define BE_NONE                 0
 658 #define BE_MISC                 1       /* Miscellaneous error */
 659 #define BE_SOCKET               2       /* Socket error */
 660 #define BE_BGP_RX               3       /* BGP protocol error notification received */
 661 #define BE_BGP_TX               4       /* BGP protocol error notification sent */
 662 #define BE_AUTO_DOWN            5       /* Automatic shutdown */
 663 #define BE_MAN_DOWN             6       /* Manual shutdown */
 664
 665 /* Misc error codes */
 666
 667 #define BEM_NEIGHBOR_LOST       1
 668 #define BEM_INVALID_NEXT_HOP    2
 669 #define BEM_INVALID_MD5         3       /* MD5 authentication kernel request failed (possibly not supported) */
 670 #define BEM_NO_SOCKET           4
 671 #define BEM_LINK_DOWN           5
 672 #define BEM_BFD_DOWN            6
 673 #define BEM_GRACEFUL_RESTART    7
 674
 675 /* Automatic shutdown error codes */
 676
 677 #define BEA_ROUTE_LIMIT_EXCEEDED 1
 678
 679 /* Well-known communities */
 680
 681 #define BGP_COMM_NO_EXPORT              0xffffff01      /* Don't export outside local AS / confed. */
 682 #define BGP_COMM_NO_ADVERTISE           0xffffff02      /* Don't export at all */
 683 #define BGP_COMM_NO_EXPORT_SUBCONFED    0xffffff03      /* NO_EXPORT even in local confederation */
 684
 685 #define BGP_COMM_LLGR_STALE             0xffff0006      /* Route is stale according to LLGR */
 686 #define BGP_COMM_NO_LLGR                0xffff0007      /* Do not treat the route according to LLGR */
 687
 688 /* Origins */
 689
 690 #define ORIGIN_IGP              0
 691 #define ORIGIN_EGP              1
 692 #define ORIGIN_INCOMPLETE       2
 693
 694
 695 #endif