bgp.h 24.8 KB
Newer Older
1 2 3 4
/*
 *	BIRD -- The Border Gateway Protocol
 *
 *	(c) 2000 Martin Mares <mj@ucw.cz>
Ondřej Zajíček's avatar
Ondřej Zajíček committed
5 6
 *	(c) 2008--2016 Ondrej Zajicek <santiago@crfreenet.org>
 *	(c) 2008--2016 CZ.NIC z.s.p.o.
7 8 9 10 11 12 13
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_BGP_H_
#define _BIRD_BGP_H_

14
#include <stdint.h>
Ondřej Zajíček's avatar
Ondřej Zajíček committed
15 16
#include <setjmp.h>
#include "nest/bird.h"
Martin Mareš's avatar
Martin Mareš committed
17
#include "nest/route.h"
Ondřej Zajíček's avatar
Ondřej Zajíček committed
18
#include "nest/bfd.h"
Ondřej Zajíček's avatar
Ondřej Zajíček committed
19
//#include "lib/lists.h"
Ondřej Zajíček's avatar
Ondřej Zajíček committed
20
#include "lib/hash.h"
Ondřej Zajíček's avatar
Ondřej Zajíček committed
21
#include "lib/socket.h"
Martin Mareš's avatar
Martin Mareš committed
22

23
struct linpool;
24
struct eattr;
25

Ondřej Zajíček's avatar
Ondřej Zajíček committed
26 27 28 29 30 31 32 33

/* Address families */

#define BGP_AFI_IPV4		1
#define BGP_AFI_IPV6		2

#define BGP_SAFI_UNICAST	1
#define BGP_SAFI_MULTICAST	2
34 35
#define BGP_SAFI_MPLS		4
#define BGP_SAFI_MPLS_VPN	128
36
#define BGP_SAFI_VPN_MULTICAST	129
37
#define BGP_SAFI_FLOW		133
Ondřej Zajíček's avatar
Ondřej Zajíček committed
38 39 40 41 42 43 44 45 46 47 48

/* Internal AF codes */

#define BGP_AF(A, B)		(((u32)(A) << 16) | (u32)(B))
#define BGP_AFI(A)		((u32)(A) >> 16)
#define BGP_SAFI(A)		((u32)(A) & 0xFFFF)

#define BGP_AF_IPV4		BGP_AF( BGP_AFI_IPV4, BGP_SAFI_UNICAST )
#define BGP_AF_IPV6		BGP_AF( BGP_AFI_IPV6, BGP_SAFI_UNICAST )
#define BGP_AF_IPV4_MC		BGP_AF( BGP_AFI_IPV4, BGP_SAFI_MULTICAST )
#define BGP_AF_IPV6_MC		BGP_AF( BGP_AFI_IPV6, BGP_SAFI_MULTICAST )
49 50 51 52
#define BGP_AF_IPV4_MPLS	BGP_AF( BGP_AFI_IPV4, BGP_SAFI_MPLS )
#define BGP_AF_IPV6_MPLS	BGP_AF( BGP_AFI_IPV6, BGP_SAFI_MPLS )
#define BGP_AF_VPN4_MPLS	BGP_AF( BGP_AFI_IPV4, BGP_SAFI_MPLS_VPN )
#define BGP_AF_VPN6_MPLS	BGP_AF( BGP_AFI_IPV6, BGP_SAFI_MPLS_VPN )
53 54
#define BGP_AF_VPN4_MC		BGP_AF( BGP_AFI_IPV4, BGP_SAFI_VPN_MULTICAST )
#define BGP_AF_VPN6_MC		BGP_AF( BGP_AFI_IPV6, BGP_SAFI_VPN_MULTICAST )
55 56
#define BGP_AF_FLOW4		BGP_AF( BGP_AFI_IPV4, BGP_SAFI_FLOW )
#define BGP_AF_FLOW6		BGP_AF( BGP_AFI_IPV6, BGP_SAFI_FLOW )
Ondřej Zajíček's avatar
Ondřej Zajíček committed
57 58 59 60 61 62 63 64 65 66


struct bgp_write_state;
struct bgp_parse_state;
struct bgp_export_state;
struct bgp_bucket;

struct bgp_af_desc {
  u32 afi;
  u32 net;
67 68
  u8 mpls;
  u8 no_igp;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
69 70 71 72 73 74 75 76 77
  const char *name;
  uint (*encode_nlri)(struct bgp_write_state *s, struct bgp_bucket *buck, byte *buf, uint size);
  void (*decode_nlri)(struct bgp_parse_state *s, byte *pos, uint len, rta *a);
  void (*update_next_hop)(struct bgp_export_state *s, eattr *nh, ea_list **to);
  uint (*encode_next_hop)(struct bgp_write_state *s, eattr *nh, byte *buf, uint size);
  void (*decode_next_hop)(struct bgp_parse_state *s, byte *pos, uint len, rta *a);
};


78 79
struct bgp_config {
  struct proto_config c;
80
  u32 local_as, remote_as;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
81
  ip_addr local_ip;			/* Source address to use */
82
  ip_addr remote_ip;
83
  struct iface *iface;			/* Interface for link-local addresses */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
84
  u16 local_port;			/* Local listening port */
85
  u16 remote_port; 			/* Neighbor destination port */
86
  int multihop;				/* Number of hops if multihop */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
87
  int strict_bind;			/* Bind listening socket to local address */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
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 95
  u32 default_local_pref;		/* Default value for LOCAL_PREF attribute */
  u32 default_med;			/* Default value for MULTI_EXIT_DISC attribute */
96
  int capabilities;			/* Enable capability handshake [RFC 5492] */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
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 101
  u32 rr_cluster_id;			/* Route reflector cluster ID, if different from local ID */
  int rr_client;			/* Whether neighbor is RR client of me */
102
  int rs_client;			/* Whether neighbor is RS client of me */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
103 104
  u32 confederation;			/* Confederation ID, or zero if confeds not active */
  int confederation_member;		/* Whether neighbor AS is member of our confederation */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
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 116
  unsigned connect_delay_time;		/* Minimum delay between connect attempts */
  unsigned connect_retry_time;		/* Timeout for connect attempts */
117 118
  unsigned hold_time, initial_hold_time;
  unsigned keepalive_time;
119 120 121 122
  unsigned error_amnesia_time;		/* Errors are forgotten after */
  unsigned error_delay_time_min;	/* Time to wait after an error is detected */
  unsigned error_delay_time_max;
  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
};

Ondřej Zajíček's avatar
Ondřej Zajíček committed
130 131 132 133
struct bgp_channel_config {
  struct channel_config c;

  u32 afi;
134
  const struct bgp_af_desc *desc;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
135 136

  ip_addr next_hop_addr;		/* Local address for NEXT_HOP attribute */
137 138
  u8 next_hop_self;			/* Always set next hop to local IP address (NH_*) */
  u8 next_hop_keep;			/* Do not modify next hop attribute (NH_*) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
139 140 141 142
  u8 missing_lladdr;			/* What we will do when we don' know link-local addr, see MLL_* */
  u8 gw_mode;				/* How we compute route gateway from next_hop attr, see GW_* */
  u8 secondary;				/* Accept also non-best routes (i.e. RA_ACCEPTED) */
  u8 gr_able;				/* Allow full graceful restart for the channel */
143 144
  u8 llgr_able;				/* Allow full long-lived GR for the channel */
  uint llgr_time;			/* Long-lived graceful restart stale time */
145
  u8 ext_next_hop;			/* Allow both IPv4 and IPv6 next hops */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
146
  u8 add_path;				/* Use ADD-PATH extension [RFC 7911] */
147
  u8 import_table;			/* Use c.in_table as Adj-RIB-In */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
148

149 150 151
  uint rest[0];				/* Remaining items are reconfigured separately */
  struct rtable_config *igp_table_ip4;	/* Table for recursive IPv4 next hop lookups */
  struct rtable_config *igp_table_ip6;	/* Table for recursive IPv6 next hop lookups */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
152 153
};

154 155 156 157
#define NH_NO			0
#define NH_ALL			1
#define NH_IBGP			2
#define NH_EBGP			3
158

159 160 161 162 163 164
#define MLL_SELF		1
#define MLL_DROP		2
#define MLL_IGNORE		3

#define GW_DIRECT		1
#define GW_RECURSIVE		2
165

Ondřej Zajíček's avatar
Ondřej Zajíček committed
166 167 168
#define BGP_ADD_PATH_RX		1
#define BGP_ADD_PATH_TX		2
#define BGP_ADD_PATH_FULL	3
169

Ondřej Zajíček's avatar
Ondřej Zajíček committed
170 171
#define BGP_GR_ABLE		1
#define BGP_GR_AWARE		2
172

Ondřej Zajíček's avatar
Ondřej Zajíček committed
173
/* For GR capability common flags */
174 175
#define BGP_GRF_RESTART 0x80

Ondřej Zajíček's avatar
Ondřej Zajíček committed
176
/* For GR capability per-AF flags */
177 178
#define BGP_GRF_FORWARDING 0x80

179 180 181 182 183 184 185 186 187 188 189
#define BGP_LLGR_ABLE		1
#define BGP_LLGR_AWARE		2

#define BGP_LLGRF_FORWARDING 0x80

#define BGP_GRS_NONE		0	/* No GR  */
#define BGP_GRS_ACTIVE		1	/* Graceful restart per RFC 4724 */
#define BGP_GRS_LLGR		2	/* Long-lived GR phase (stale timer active) */

#define BGP_BFD_GRACEFUL	2	/* BFD down triggers graceful restart */

190

Ondřej Zajíček's avatar
Ondřej Zajíček committed
191 192 193 194 195
struct bgp_af_caps {
  u32 afi;
  u8 ready;				/* Multiprotocol capability, RFC 4760 */
  u8 gr_able;				/* Graceful restart support, RFC 4724 */
  u8 gr_af_flags;			/* Graceful restart per-AF flags */
196 197 198
  u8 llgr_able;				/* Long-lived GR, RFC draft */
  u32 llgr_time;			/* Long-lived GR stale time */
  u8 llgr_flags;			/* Long-lived GR per-AF flags */
199
  u8 ext_next_hop;			/* Extended IPv6 next hop,   RFC 5549 */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
  u8 add_path;				/* Multiple paths support,   RFC 7911 */
};

struct bgp_caps {
  u32 as4_number;			/* Announced ASN */

  u8 as4_support;			/* Four-octet AS capability, RFC 6793 */
  u8 ext_messages;			/* Extended message length,  RFC draft */
  u8 route_refresh;			/* Route refresh capability, RFC 2918 */
  u8 enhanced_refresh;			/* Enhanced route refresh,   RFC 7313 */

  u8 gr_aware;				/* Graceful restart capability, RFC 4724 */
  u8 gr_flags;				/* Graceful restart flags */
  u16 gr_time;				/* Graceful restart time in seconds */

215 216
  u8 llgr_aware;			/* Long-lived GR capability, RFC draft */

Ondřej Zajíček's avatar
Ondřej Zajíček committed
217 218 219 220 221
  u16 af_count;				/* Number of af_data items */

  struct bgp_af_caps af_data[0];	/* Per-AF capability data */
};

222 223 224 225
#define WALK_AF_CAPS(caps,ac) \
  for (ac = caps->af_data; ac < &caps->af_data[caps->af_count]; ac++)


Ondřej Zajíček's avatar
Ondřej Zajíček committed
226 227 228 229 230 231
struct bgp_socket {
  node n;				/* Node in global bgp_sockets */
  sock *sk;				/* Real listening socket */
  u32 uc;				/* Use count */
};

232 233 234
struct bgp_conn {
  struct bgp_proto *bgp;
  struct birdsock *sk;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
235 236 237 238 239 240
  u8 state;				/* State of connection state machine */
  u8 as4_session;			/* Session uses 4B AS numbers in AS_PATH (both sides support it) */
  u8 ext_messages;			/* Session uses extended message length */

  struct bgp_caps *local_caps;
  struct bgp_caps *remote_caps;
241 242 243 244
  timer *connect_timer;
  timer *hold_timer;
  timer *keepalive_timer;
  event *tx_ev;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
245 246 247 248
  u32 packets_to_send;			/* Bitmap of packet types to be sent */
  u32 channels_to_send;			/* Bitmap of channels with packets to be sent */
  u8 last_channel;			/* Channel used last time for TX */
  u8 last_channel_count;		/* Number of times the last channel was used in succession */
249 250
  int notify_code, notify_subcode, notify_size;
  byte *notify_data;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
251 252

  uint hold_time, keepalive_time;	/* Times calculated from my and neighbor's requirements */
253 254 255 256
};

struct bgp_proto {
  struct proto p;
257
  struct bgp_config *cf;		/* Shortcut to BGP configuration */
258
  u32 local_as, remote_as;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
259
  u32 public_as;			/* Externally visible ASN (local_as or confederation id) */
260 261
  u32 local_id;				/* BGP identifier of this router */
  u32 remote_id;			/* BGP identifier of the neighbor */
262
  u32 rr_cluster_id;			/* Route reflector cluster ID */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
263 264 265 266 267 268 269 270
  int start_state;			/* Substates that partitions BS_START */
  u8 is_internal;			/* Internal BGP session (local_as == remote_as) */
  u8 is_interior;			/* Internal or intra-confederation BGP session */
  u8 as4_session;			/* Session uses 4B AS numbers in AS_PATH (both sides support it) */
  u8 rr_client;				/* Whether neighbor is RR client of me */
  u8 rs_client;				/* Whether neighbor is RS client of me */
  u8 route_refresh;			/* Route refresh allowed to send [RFC 2918] */
  u8 enhanced_refresh;			/* Enhanced refresh is negotiated [RFC 7313] */
271
  u8 gr_ready;				/* Neighbor could do graceful restart */
272
  u8 llgr_ready;			/* Neighbor could do Long-lived GR, implies gr_ready */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
273 274
  u8 gr_active_num;			/* Neighbor is doing GR, number of active channels */
  u8 channel_count;			/* Number of active channels */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
275
  u8 summary_add_path_rx;		/* Summary state of ADD_PATH RX w.r.t active channels */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
276 277
  u32 *afi_map;				/* Map channel index -> AFI */
  struct bgp_channel **channel_map;	/* Map channel index -> channel */
278 279
  struct bgp_conn *conn;		/* Connection we have established */
  struct bgp_conn outgoing_conn;	/* Outgoing connection we're working with */
280 281
  struct bgp_conn incoming_conn;	/* Incoming connection we have neither accepted nor rejected yet */
  struct object_lock *lock;		/* Lock for neighbor connection */
282
  struct neighbor *neigh;		/* Neighbor entry corresponding to remote ip, NULL if multihop */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
283
  struct bgp_socket *sock;		/* Shared listening socket */
284
  struct bfd_request *bfd_req;		/* BFD request, if BFD is used */
285
  ip_addr source_addr;			/* Local address used as an advertised next hop */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
286
  ip_addr link_addr;			/* Link-local version of source_addr */
287 288 289
  event *event;				/* Event for respawning and shutting process */
  timer *startup_timer;			/* Timer used to delay protocol startup due to previous errors (startup_delay) */
  timer *gr_timer;			/* Timer waiting for reestablishment after graceful restart */
290 291
  uint startup_delay;			/* Delay (in seconds) of protocol startup due to previous errors */
  btime last_proto_error;		/* Time of last error that leads to protocol stop */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
292 293 294
  u8 last_error_class; 			/* Error class of last error */
  u32 last_error_code;			/* Error code of last error. BGP protocol errors
					   are encoded as (bgp_err_code << 16 | bgp_err_subcode) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
295 296 297 298 299 300 301 302 303 304 305 306
};

struct bgp_channel {
  struct channel c;

  /* Rest are BGP specific data */
  struct bgp_channel_config *cf;

  u32 afi;
  u32 index;
  const struct bgp_af_desc *desc;

307 308 309 310 311
  rtable *igp_table_ip4;		/* Table for recursive IPv4 next hop lookups */
  rtable *igp_table_ip6;		/* Table for recursive IPv6 next hop lookups */

  /* Rest are zeroed when down */
  pool *pool;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
312 313 314 315 316 317 318 319 320 321 322 323
  HASH(struct bgp_bucket) bucket_hash;	/* Hash table of route buckets */
  struct bgp_bucket *withdraw_bucket;	/* Withdrawn routes */
  list bucket_queue;			/* Queue of buckets to send (struct bgp_bucket) */

  HASH(struct bgp_prefix) prefix_hash;	/* Prefixes to be sent */
  slab *prefix_slab;			/* Slab holding prefix nodes */

  ip_addr next_hop_addr;		/* Local address for NEXT_HOP attribute */
  ip_addr link_addr;			/* Link-local version of next_hop_addr */

  u32 packets_to_send;			/* Bitmap of packet types to be sent */

324 325
  u8 ext_next_hop;			/* Session allows both IPv4 and IPv6 next hops */

Ondřej Zajíček's avatar
Ondřej Zajíček committed
326
  u8 gr_ready;				/* Neighbor could do GR on this AF */
327
  u8 gr_active;				/* Neighbor is doing GR (BGP_GRS_*) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
328

329 330
  timer *stale_timer;			/* Long-lived stale timer for LLGR */
  u32 stale_time;			/* Stored LLGR stale time from last session */
331

Ondřej Zajíček's avatar
Ondřej Zajíček committed
332 333 334 335 336
  u8 add_path_rx;			/* Session expects receive of ADD-PATH extended NLRI */
  u8 add_path_tx;			/* Session expects transmit of ADD-PATH extended NLRI */

  u8 feed_state;			/* Feed state (TX) for EoR, RR packets, see BFS_* */
  u8 load_state;			/* Load state (RX) for EoR, RR packets, see BFS_* */
Martin Mareš's avatar
Martin Mareš committed
337 338 339
};

struct bgp_prefix {
Ondřej Zajíček's avatar
Ondřej Zajíček committed
340 341 342
  node buck_node;			/* Node in per-bucket list */
  struct bgp_prefix *next;		/* Node in prefix hash table */
  u32 hash;
343
  u32 path_id;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
344
  net_addr net[0];
Martin Mareš's avatar
Martin Mareš committed
345 346 347 348
};

struct bgp_bucket {
  node send_node;			/* Node in send queue */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
349 350 351
  struct bgp_bucket *next;		/* Node in bucket hash table */
  list prefixes;			/* Prefixes in this bucket (struct bgp_prefix) */
  u32 hash;				/* Hash over extended attributes */
Martin Mareš's avatar
Martin Mareš committed
352
  ea_list eattrs[0];			/* Per-bucket extended attributes */
353 354
};

Ondřej Zajíček's avatar
Ondřej Zajíček committed
355 356 357 358 359 360 361
struct bgp_export_state {
  struct bgp_proto *proto;
  struct bgp_channel *channel;
  struct linpool *pool;

  struct bgp_proto *src;
  rte *route;
362
  int mpls;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
363 364 365 366 367 368 369 370 371 372

  u32 attrs_seen[1];
  uint err_withdraw;
};

struct bgp_write_state {
  struct bgp_proto *proto;
  struct bgp_channel *channel;
  struct linpool *pool;

Ondřej Zajíček's avatar
Ondřej Zajíček committed
373
  int mp_reach;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
374 375
  int as4_session;
  int add_path;
376
  int mpls;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
377 378

  eattr *mp_next_hop;
379
  adata *mpls_labels;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
380 381 382 383 384 385 386 387 388
};

struct bgp_parse_state {
  struct bgp_proto *proto;
  struct bgp_channel *channel;
  struct linpool *pool;

  int as4_session;
  int add_path;
389
  int mpls;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415

  u32 attrs_seen[256/32];

  u32 mp_reach_af;
  u32 mp_unreach_af;

  uint attr_len;
  uint ip_reach_len;
  uint ip_unreach_len;
  uint ip_next_hop_len;
  uint mp_reach_len;
  uint mp_unreach_len;
  uint mp_next_hop_len;

  byte *attrs;
  byte *ip_reach_nlri;
  byte *ip_unreach_nlri;
  byte *ip_next_hop_data;
  byte *mp_reach_nlri;
  byte *mp_unreach_nlri;
  byte *mp_next_hop_data;

  uint err_withdraw;
  uint err_subcode;
  jmp_buf err_jmpbuf;

416 417 418
  struct hostentry *hostentry;
  adata *mpls_labels;

Ondřej Zajíček's avatar
Ondřej Zajíček committed
419 420 421 422 423 424
  /* Cached state for bgp_rte_update() */
  u32 last_id;
  struct rte_src *last_src;
  rta *cached_rta;
};

425 426 427
#define BGP_PORT		179
#define BGP_VERSION		4
#define BGP_HEADER_LENGTH	19
428 429
#define BGP_MAX_MESSAGE_LENGTH	4096
#define BGP_MAX_EXT_MSG_LENGTH	65535
430
#define BGP_RX_BUFFER_SIZE	4096
431 432 433 434
#define BGP_TX_BUFFER_SIZE	4096
#define BGP_RX_BUFFER_EXT_SIZE	65535
#define BGP_TX_BUFFER_EXT_SIZE	65535

Ondřej Zajíček's avatar
Ondřej Zajíček committed
435 436 437 438 439 440
static inline int bgp_channel_is_ipv4(struct bgp_channel *c)
{ return BGP_AFI(c->afi) == BGP_AFI_IPV4; }

static inline int bgp_channel_is_ipv6(struct bgp_channel *c)
{ return BGP_AFI(c->afi) == BGP_AFI_IPV6; }

441 442 443 444 445 446
static inline int bgp_cc_is_ipv4(struct bgp_channel_config *c)
{ return BGP_AFI(c->afi) == BGP_AFI_IPV4; }

static inline int bgp_cc_is_ipv6(struct bgp_channel_config *c)
{ return BGP_AFI(c->afi) == BGP_AFI_IPV6; }

Ondřej Zajíček's avatar
Ondřej Zajíček committed
447 448 449 450 451 452 453 454 455
static inline uint bgp_max_packet_length(struct bgp_conn *conn)
{ return conn->ext_messages ? BGP_MAX_EXT_MSG_LENGTH : BGP_MAX_MESSAGE_LENGTH; }

static inline void
bgp_parse_error(struct bgp_parse_state *s, uint subcode)
{
  s->err_subcode = subcode;
  longjmp(s->err_jmpbuf, 1);
}
456

457
extern struct linpool *bgp_linpool;
458
extern struct linpool *bgp_linpool2;
459

460

461
void bgp_start_timer(timer *t, uint value);
462
void bgp_check_config(struct bgp_config *c);
463
void bgp_error(struct bgp_conn *c, unsigned code, unsigned subcode, byte *data, int len);
464
void bgp_close_conn(struct bgp_conn *c);
465
void bgp_update_startup_delay(struct bgp_proto *p);
466
void bgp_conn_enter_openconfirm_state(struct bgp_conn *conn);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
467 468 469
void bgp_conn_enter_established_state(struct bgp_conn *conn);
void bgp_conn_enter_close_state(struct bgp_conn *conn);
void bgp_conn_enter_idle_state(struct bgp_conn *conn);
470
void bgp_handle_graceful_restart(struct bgp_proto *p);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
471 472 473
void bgp_graceful_restart_done(struct bgp_channel *c);
void bgp_refresh_begin(struct bgp_channel *c);
void bgp_refresh_end(struct bgp_channel *c);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
474
void bgp_store_error(struct bgp_proto *p, struct bgp_conn *c, u8 class, u32 code);
475
void bgp_stop(struct bgp_proto *p, uint subcode, byte *data, uint len);
476

477 478 479
struct rte_source *bgp_find_source(struct bgp_proto *p, u32 path_id);
struct rte_source *bgp_get_source(struct bgp_proto *p, u32 path_id);

Ondřej Zajíček's avatar
Ondřej Zajíček committed
480

481

Martin Mareš's avatar
Martin Mareš committed
482 483 484 485 486 487 488 489
#ifdef LOCAL_DEBUG
#define BGP_FORCE_DEBUG 1
#else
#define BGP_FORCE_DEBUG 0
#endif
#define BGP_TRACE(flags, msg, args...) do { if ((p->p.debug & flags) || BGP_FORCE_DEBUG) \
	log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)

490 491 492 493
#define BGP_TRACE_RL(rl, flags, msg, args...) do { if ((p->p.debug & flags) || BGP_FORCE_DEBUG) \
	log_rl(rl, L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)


494 495
/* attrs.c */

Ondřej Zajíček's avatar
Ondřej Zajíček committed
496 497 498
static inline eattr *
bgp_find_attr(ea_list *attrs, uint code)
{
499
  return ea_find(attrs, EA_CODE(PROTOCOL_BGP, code));
Ondřej Zajíček's avatar
Ondřej Zajíček committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
}

eattr *
bgp_set_attr(ea_list **attrs, struct linpool *pool, uint code, uint flags, uintptr_t val);

static inline void
bgp_set_attr_u32(ea_list **to, struct linpool *pool, uint code, uint flags, u32 val)
{ bgp_set_attr(to, pool, code, flags, (uintptr_t) val); }

static inline void
bgp_set_attr_ptr(ea_list **to, struct linpool *pool, uint code, uint flags, struct adata *val)
{ bgp_set_attr(to, pool, code, flags, (uintptr_t) val); }

static inline void
bgp_set_attr_data(ea_list **to, struct linpool *pool, uint code, uint flags, void *data, uint len)
{
  struct adata *a = lp_alloc_adata(pool, len);
  memcpy(a->data, data, len);
  bgp_set_attr(to, pool, code, flags, (uintptr_t) a);
}

static inline void
bgp_unset_attr(ea_list **to, struct linpool *pool, uint code)
{ eattr *e = bgp_set_attr(to, pool, code, 0, 0); e->type = EAF_TYPE_UNDEF; }


int bgp_encode_attrs(struct bgp_write_state *s, ea_list *attrs, byte *buf, byte *end);
ea_list * bgp_decode_attrs(struct bgp_parse_state *s, byte *data, uint len);

void bgp_init_bucket_table(struct bgp_channel *c);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
530
void bgp_free_bucket_table(struct bgp_channel *c);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
531 532 533 534 535
void bgp_free_bucket(struct bgp_channel *c, struct bgp_bucket *b);
void bgp_defer_bucket(struct bgp_channel *c, struct bgp_bucket *b);
void bgp_withdraw_bucket(struct bgp_channel *c, struct bgp_bucket *b);

void bgp_init_prefix_table(struct bgp_channel *c);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
536
void bgp_free_prefix_table(struct bgp_channel *c);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
537 538
void bgp_free_prefix(struct bgp_channel *c, struct bgp_prefix *bp);

Martin Mareš's avatar
Martin Mareš committed
539
int bgp_rte_better(struct rte *, struct rte *);
540
int bgp_rte_mergable(rte *pri, rte *sec);
541
int bgp_rte_recalculate(rtable *table, net *net, rte *new, rte *old, rte *old_best);
542
struct rte *bgp_rte_modify_stale(struct rte *r, struct linpool *pool);
543
void bgp_rt_notify(struct proto *P, struct channel *C, net *n, rte *new, rte *old);
544
int bgp_preexport(struct proto *, struct rte **, struct linpool *);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
545
int bgp_get_attr(struct eattr *e, byte *buf, int buflen);
546
void bgp_get_route_info(struct rte *, byte *buf);
547

548

549 550
/* packets.c */

Ondřej Zajíček's avatar
Ondřej Zajíček committed
551
void bgp_dump_state_change(struct bgp_conn *conn, uint old, uint new);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
552 553 554
const struct bgp_af_desc *bgp_get_af_desc(u32 afi);
const struct bgp_af_caps *bgp_find_af_caps(struct bgp_caps *caps, u32 afi);
void bgp_schedule_packet(struct bgp_conn *conn, struct bgp_channel *c, int type);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
555
void bgp_kick_tx(void *vconn);
556
void bgp_tx(struct birdsock *sk);
557
int bgp_rx(struct birdsock *sk, uint size);
558
const char * bgp_error_dsc(unsigned code, unsigned subcode);
559
void bgp_log_error(struct bgp_proto *p, u8 class, char *msg, unsigned code, unsigned subcode, byte *data, unsigned len);
560

Ondřej Zajíček's avatar
Ondřej Zajíček committed
561 562 563
void bgp_update_next_hop(struct bgp_export_state *s, eattr *a, ea_list **to);


564 565 566 567 568 569
/* Packet types */

#define PKT_OPEN		0x01
#define PKT_UPDATE		0x02
#define PKT_NOTIFICATION	0x03
#define PKT_KEEPALIVE		0x04
570 571
#define PKT_ROUTE_REFRESH	0x05	/* [RFC2918] */
#define PKT_BEGIN_REFRESH	0x1e	/* Dummy type for BoRR packet [RFC7313] */
572
#define PKT_SCHEDULE_CLOSE	0x1f	/* Used internally to schedule socket close */
573 574 575 576 577 578 579 580

/* Attributes */

#define BAF_OPTIONAL		0x80
#define BAF_TRANSITIVE		0x40
#define BAF_PARTIAL		0x20
#define BAF_EXT_LEN		0x10

Ondřej Zajíček's avatar
Ondřej Zajíček committed
581
#define BA_ORIGIN		0x01	/* RFC 4271 */		/* WM */
582 583 584
#define BA_AS_PATH		0x02				/* WM */
#define BA_NEXT_HOP		0x03				/* WM */
#define BA_MULTI_EXIT_DISC	0x04				/* ON */
585
#define BA_LOCAL_PREF		0x05				/* WD */
586 587
#define BA_ATOMIC_AGGR		0x06				/* WD */
#define BA_AGGREGATOR		0x07				/* OT */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
588 589 590 591 592
#define BA_COMMUNITY		0x08	/* RFC 1997 */		/* OT */
#define BA_ORIGINATOR_ID	0x09	/* RFC 4456 */		/* ON */
#define BA_CLUSTER_LIST		0x0a	/* RFC 4456 */		/* ON */
#define BA_MP_REACH_NLRI	0x0e	/* RFC 4760 */
#define BA_MP_UNREACH_NLRI	0x0f	/* RFC 4760 */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
593 594 595
#define BA_EXT_COMMUNITY	0x10	/* RFC 4360 */
#define BA_AS4_PATH             0x11	/* RFC 6793 */
#define BA_AS4_AGGREGATOR       0x12	/* RFC 6793 */
596
#define BA_LARGE_COMMUNITY	0x20	/* RFC 8092 */
597

598 599 600
/* Bird's private internal BGP attributes */
#define BA_MPLS_LABEL_STACK	0xfe	/* MPLS label stack transfer attribute */

Ondřej Zajíček's avatar
Ondřej Zajíček committed
601
/* BGP connection states */
602 603 604 605 606 607 608

#define BS_IDLE			0
#define BS_CONNECT		1	/* Attempting to connect */
#define BS_ACTIVE		2	/* Waiting for connection retry & listening */
#define BS_OPENSENT		3
#define BS_OPENCONFIRM		4
#define BS_ESTABLISHED		5
Ondřej Zajíček's avatar
Ondřej Zajíček committed
609 610
#define BS_CLOSE		6	/* Used during transition to BS_IDLE */

611 612
#define BS_MAX			7

Ondřej Zajíček's avatar
Ondřej Zajíček committed
613
/* BGP start states
614
 *
Ondřej Zajíček's avatar
Ondřej Zajíček committed
615 616
 * Used in PS_START for fine-grained specification of starting state.
 *
617 618
 * When BGP protocol is started by core, it goes to BSS_PREPARE. When BGP
 * protocol done what is neccessary to start itself (like acquiring the lock),
Ondřej Zajíček's avatar
Ondřej Zajíček committed
619
 * it goes to BSS_CONNECT.
Ondřej Zajíček's avatar
Ondřej Zajíček committed
620 621 622
 */

#define BSS_PREPARE		0	/* Used before ordinary BGP started, i. e. waiting for lock */
623 624
#define BSS_DELAY		1	/* Startup delay due to previous errors */
#define BSS_CONNECT		2	/* Ordinary BGP connecting */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
625

626 627 628 629 630 631 632

/* BGP feed states (TX)
 *
 * RFC 4724 specifies that an initial feed should end with End-of-RIB mark.
 *
 * RFC 7313 specifies that a route refresh should be demarcated by BoRR and EoRR packets.
 *
Ondřej Zajíček's avatar
Ondřej Zajíček committed
633
 * These states (stored in c->feed_state) are used to keep track of these
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
 * requirements. When such feed is started, BFS_LOADING / BFS_REFRESHING is
 * set. When it ended, BFS_LOADED / BFS_REFRESHED is set to schedule End-of-RIB
 * or EoRR packet. When the packet is sent, the state returned to BFS_NONE.
 *
 * Note that when a non-demarcated feed (e.g. plain RFC 4271 initial load
 * without End-of-RIB or plain RFC 2918 route refresh without BoRR/EoRR
 * demarcation) is active, BFS_NONE is set.
 *
 * BFS_NONE, BFS_LOADING and BFS_REFRESHING are also used as load states (RX)
 * with correspondent semantics (-, expecting End-of-RIB, expecting EoRR).
 */

#define BFS_NONE		0	/* No feed or original non-demarcated feed */
#define BFS_LOADING		1	/* Initial feed active, End-of-RIB planned */
#define BFS_LOADED		2	/* Loading done, End-of-RIB marker scheduled */
#define BFS_REFRESHING		3	/* Route refresh (introduced by BoRR) active */
#define BFS_REFRESHED		4	/* Refresh done, EoRR packet scheduled */


Ondřej Zajíček's avatar
Ondřej Zajíček committed
653 654 655 656 657 658 659 660 661 662 663 664 665 666
/* Error classes */

#define BE_NONE			0
#define BE_MISC			1	/* Miscellaneous error */
#define BE_SOCKET		2	/* Socket error */
#define BE_BGP_RX		3	/* BGP protocol error notification received */
#define BE_BGP_TX		4	/* BGP protocol error notification sent */
#define BE_AUTO_DOWN		5	/* Automatic shutdown */
#define BE_MAN_DOWN		6	/* Manual shutdown */

/* Misc error codes */

#define BEM_NEIGHBOR_LOST	1
#define BEM_INVALID_NEXT_HOP	2
667
#define BEM_INVALID_MD5		3	/* MD5 authentication kernel request failed (possibly not supported) */
668
#define BEM_NO_SOCKET		4
669 670 671
#define BEM_LINK_DOWN		5
#define BEM_BFD_DOWN		6
#define BEM_GRACEFUL_RESTART	7
Ondřej Zajíček's avatar
Ondřej Zajíček committed
672

673 674 675
/* Automatic shutdown error codes */

#define BEA_ROUTE_LIMIT_EXCEEDED 1
676

677 678 679 680 681 682
/* Well-known communities */

#define BGP_COMM_NO_EXPORT		0xffffff01	/* Don't export outside local AS / confed. */
#define BGP_COMM_NO_ADVERTISE		0xffffff02	/* Don't export at all */
#define BGP_COMM_NO_EXPORT_SUBCONFED	0xffffff03	/* NO_EXPORT even in local confederation */

683 684 685
#define BGP_COMM_LLGR_STALE		0xffff0006	/* Route is stale according to LLGR */
#define BGP_COMM_NO_LLGR		0xffff0007	/* Do not treat the route according to LLGR */

686 687 688 689 690 691
/* Origins */

#define ORIGIN_IGP		0
#define ORIGIN_EGP		1
#define ORIGIN_INCOMPLETE	2

692

693
#endif