bgp.h 10.6 KB
Newer Older
Martin Mareš's avatar
Martin Mareš committed
1
2
3
4
5
6
7
8
9
10
11
/*
 *	BIRD -- The Border Gateway Protocol
 *
 *	(c) 2000 Martin Mares <mj@ucw.cz>
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_BGP_H_
#define _BIRD_BGP_H_

Martin Mareš's avatar
Martin Mareš committed
12
13
#include "nest/route.h"

Martin Mareš's avatar
Martin Mareš committed
14
struct linpool;
15
struct eattr;
Martin Mareš's avatar
Martin Mareš committed
16

Martin Mareš's avatar
Martin Mareš committed
17
18
struct bgp_config {
  struct proto_config c;
19
  u32 local_as, remote_as;
Martin Mareš's avatar
Martin Mareš committed
20
21
  ip_addr remote_ip;
  int multihop;				/* Number of hops if multihop */
Martin Mareš's avatar
Martin Mareš committed
22
  ip_addr multihop_via;			/* Multihop: address to route to */
23
  ip_addr source_addr;			/* Source address to use */
24
  int next_hop_self;			/* Always set next hop to local IP address */
25
26
27
  int compare_path_lengths;		/* Use path lengths when selecting best route */
  u32 default_local_pref;		/* Default value for LOCAL_PREF attribute */
  u32 default_med;			/* Default value for MULTI_EXIT_DISC attribute */
28
  int capabilities;			/* Enable capability handshake [RFC3392] */
29
  int enable_as4;			/* Enable local support for 4B AS numbers [RFC4893] */
30
31
  u32 rr_cluster_id;			/* Route reflector cluster ID, if different from local ID */
  int rr_client;			/* Whether neighbor is RR client of me */
32
  int rs_client;			/* Whether neighbor is RS client of me */
33
  int advertise_ipv4;			/* Whether we should add IPv4 capability advertisement to OPEN message */
34
35
36
  unsigned connect_retry_time;
  unsigned hold_time, initial_hold_time;
  unsigned keepalive_time;
37
38
39
40
41
  unsigned start_delay_time;		/* Minimum delay between connects */
  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 */
42
  char *password;			/* Password used for MD5 authentication */
43
44
45
46
47
};

struct bgp_conn {
  struct bgp_proto *bgp;
  struct birdsock *sk;
Martin Mareš's avatar
Martin Mareš committed
48
  unsigned int state;			/* State of connection state machine */
49
50
51
  struct timer *connect_retry_timer;
  struct timer *hold_timer;
  struct timer *keepalive_timer;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
52
  struct event *tx_ev;
53
  int packets_to_send;			/* Bitmap of packet types to be sent */
54
55
  int notify_code, notify_subcode, notify_size;
  byte *notify_data;
56
  u32 advertised_as;			/* Temporary value for AS number received */
57
58
59
  int start_state;			/* protocol start_state snapshot when connection established */
  int want_as4_support;			/* Connection tries to establish AS4 session */
  int peer_as4_support;			/* Peer supports 4B AS numbers [RFC4893] */
60
  unsigned hold_time, keepalive_time;	/* Times calculated from my and neighbor's requirements */
Martin Mareš's avatar
Martin Mareš committed
61
62
63
64
};

struct bgp_proto {
  struct proto p;
65
  struct bgp_config *cf;		/* Shortcut to BGP configuration */
66
  u32 local_as, remote_as;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
67
  int start_state;			/* Substates that partitions BS_START */
68
  int is_internal;			/* Internal BGP connection (local_as == remote_as) */
69
  int as4_session;			/* Session uses 4B AS numbers in AS_PATH (both sides support it) */
70
71
  u32 local_id;				/* BGP identifier of this router */
  u32 remote_id;			/* BGP identifier of the neighbor */
72
73
  u32 rr_cluster_id;			/* Route reflector cluster ID */
  int rr_client;			/* Whether neighbor is RR client of me */
74
  int rs_client;			/* Whether neighbor is RS client of me */
75
76
  struct bgp_conn *conn;		/* Connection we have established */
  struct bgp_conn outgoing_conn;	/* Outgoing connection we're working with */
77
78
  struct bgp_conn incoming_conn;	/* Incoming connection we have neither accepted nor rejected yet */
  struct object_lock *lock;		/* Lock for neighbor connection */
79
80
81
  ip_addr next_hop;			/* Either the peer or multihop_via */
  struct neighbor *neigh;		/* Neighbor entry corresponding to next_hop */
  ip_addr local_addr;			/* Address of the local end of the link to next_hop */
82
  ip_addr source_addr;			/* Address used as advertised next hop, usually local_addr */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
83
  struct event *event;			/* Event for respawning and shutting process */
Martin Mareš's avatar
Martin Mareš committed
84
  struct bgp_bucket **bucket_hash;	/* Hash table of attribute buckets */
85
  unsigned int hash_size, hash_count, hash_limit;
Martin Mareš's avatar
Martin Mareš committed
86
87
88
  struct fib prefix_fib;		/* Prefixes to be sent */
  list bucket_queue;			/* Queue of buckets to send */
  struct bgp_bucket *withdraw_bucket;	/* Withdrawn routes */
89
  unsigned startup_delay;		/* Time to delay protocol startup by due to errors */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
90
91
92
93
  bird_clock_t last_proto_error;	/* Time of last error that leads to protocol stop */
  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) */
Martin Mareš's avatar
Martin Mareš committed
94
95
96
#ifdef IPV6
  byte *mp_reach_start, *mp_unreach_start; /* Multiprotocol BGP attribute notes */
  unsigned mp_reach_len, mp_unreach_len;
97
  ip_addr local_link;			/* Link-level version of local_addr */
Martin Mareš's avatar
Martin Mareš committed
98
#endif
Martin Mareš's avatar
Martin Mareš committed
99
100
101
102
103
104
105
106
107
};

struct bgp_prefix {
  struct fib_node n;			/* Node in prefix fib */
  node bucket_node;			/* Node in per-bucket list */
};

struct bgp_bucket {
  node send_node;			/* Node in send queue */
108
  struct bgp_bucket *hash_next, *hash_prev;	/* Node in bucket hash table */
Martin Mareš's avatar
Martin Mareš committed
109
110
111
  unsigned hash;			/* Hash over extended attributes */
  list prefixes;			/* Prefixes in this buckets */
  ea_list eattrs[0];			/* Per-bucket extended attributes */
Martin Mareš's avatar
Martin Mareš committed
112
113
};

Martin Mareš's avatar
Martin Mareš committed
114
115
116
117
118
119
#define BGP_PORT		179
#define BGP_VERSION		4
#define BGP_HEADER_LENGTH	19
#define BGP_MAX_PACKET_LENGTH	4096
#define BGP_RX_BUFFER_SIZE	4096
#define BGP_TX_BUFFER_SIZE	BGP_MAX_PACKET_LENGTH
Martin Mareš's avatar
Martin Mareš committed
120

121
122
extern struct linpool *bgp_linpool;

123
124
125
extern int bgp_as4_support;


126
void bgp_start_timer(struct timer *t, int value);
Martin Mareš's avatar
Martin Mareš committed
127
void bgp_check(struct bgp_config *c);
128
void bgp_error(struct bgp_conn *c, unsigned code, unsigned subcode, byte *data, int len);
129
void bgp_close_conn(struct bgp_conn *c);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
130
131
132
133
134
135
void bgp_update_startup_delay(struct bgp_proto *p, struct bgp_conn *conn, unsigned code, unsigned subcode);
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);
void bgp_store_error(struct bgp_proto *p, struct bgp_conn *c, u8 class, u32 code);

Martin Mareš's avatar
Martin Mareš committed
136

Martin Mareš's avatar
Martin Mareš committed
137
138
139
140
141
142
143
144
#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)

145
146
147
148
#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)


149
150
/* attrs.c */

151
152
void bgp_attach_attr(struct ea_list **to, struct linpool *pool, unsigned attr, uintptr_t val);
byte *bgp_attach_attr_wa(struct ea_list **to, struct linpool *pool, unsigned attr, unsigned len);
153
struct rta *bgp_decode_attrs(struct bgp_conn *conn, byte *a, unsigned int len, struct linpool *pool, int mandatory);
154
int bgp_get_attr(struct eattr *e, byte *buf, int buflen);
Martin Mareš's avatar
Martin Mareš committed
155
156
157
int bgp_rte_better(struct rte *, struct rte *);
void bgp_rt_notify(struct proto *, struct network *, struct rte *, struct rte *, struct ea_list *);
int bgp_import_control(struct proto *, struct rte **, struct ea_list **, struct linpool *);
158
void bgp_attr_init(struct bgp_proto *);
159
unsigned int bgp_encode_attrs(struct bgp_proto *p, byte *w, ea_list *attrs, int remains);
160
void bgp_free_bucket(struct bgp_proto *p, struct bgp_bucket *buck);
161
void bgp_get_route_info(struct rte *, byte *buf, struct ea_list *attrs);
Martin Mareš's avatar
Martin Mareš committed
162

163
164
165
inline static void bgp_attach_attr_ip(struct ea_list **to, struct linpool *pool, unsigned attr, ip_addr a)
{ *(ip_addr *) bgp_attach_attr_wa(to, pool, attr, sizeof(ip_addr)) = a; }

166
167
/* packets.c */

Martin Mareš's avatar
Martin Mareš committed
168
void bgp_schedule_packet(struct bgp_conn *conn, int type);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
169
void bgp_kick_tx(void *vconn);
Martin Mareš's avatar
Martin Mareš committed
170
171
void bgp_tx(struct birdsock *sk);
int bgp_rx(struct birdsock *sk, int size);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
172
const byte * bgp_error_dsc(byte *buff, unsigned code, unsigned subcode);
173
void bgp_log_error(struct bgp_proto *p, char *msg, unsigned code, unsigned subcode, byte *data, unsigned len);
Martin Mareš's avatar
Martin Mareš committed
174

175
176
177
178
179
180
/* Packet types */

#define PKT_OPEN		0x01
#define PKT_UPDATE		0x02
#define PKT_NOTIFICATION	0x03
#define PKT_KEEPALIVE		0x04
Martin Mareš's avatar
Martin Mareš committed
181
#define PKT_SCHEDULE_CLOSE	0x1f	/* Used internally to schedule socket close */
182
183
184
185
186
187
188
189
190
191
192
193

/* Attributes */

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

#define BA_ORIGIN		0x01	/* [RFC1771] */		/* WM */
#define BA_AS_PATH		0x02				/* WM */
#define BA_NEXT_HOP		0x03				/* WM */
#define BA_MULTI_EXIT_DISC	0x04				/* ON */
Martin Mareš's avatar
Martin Mareš committed
194
#define BA_LOCAL_PREF		0x05				/* WD */
195
196
197
198
199
200
201
202
203
204
205
206
#define BA_ATOMIC_AGGR		0x06				/* WD */
#define BA_AGGREGATOR		0x07				/* OT */
#define BA_COMMUNITY		0x08	/* [RFC1997] */		/* OT */
#define BA_ORIGINATOR_ID	0x09	/* [RFC1966] */		/* ON */
#define BA_CLUSTER_LIST		0x0a				/* ON */
/* We don't support these: */
#define BA_DPA			0x0b	/* ??? */
#define BA_ADVERTISER		0x0c	/* [RFC1863] */
#define BA_RCID_PATH		0x0d
#define BA_MP_REACH_NLRI	0x0e	/* [RFC2283] */
#define BA_MP_UNREACH_NLRI	0x0f
#define BA_EXTENDED_COMM	0x10	/* draft-ramachandra-bgp-ext-communities */
207
208
#define BA_AS4_PATH             0x11    /* [RFC4893] */
#define BA_AS4_AGGREGATOR       0x12
209

Ondřej Zajíček's avatar
Ondřej Zajíček committed
210
/* BGP connection states */
211
212
213
214
215
216
217

#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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
#define BS_CLOSE		6	/* Used during transition to BS_IDLE */

/* BGP start states
 * 
 * Used in PS_START for fine-grained specification of starting state.
 *
 * 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), it goes to BSS_CONNECT.
 * When some connection attempt failed because of option or capability error, it goes to
 * BSS_CONNECT_NOCAP.
 */

#define BSS_PREPARE		0	/* Used before ordinary BGP started, i. e. waiting for lock */
#define BSS_CONNECT		1	/* Ordinary BGP connecting */
#define BSS_CONNECT_NOCAP	2	/* Legacy BGP connecting (without capabilities) */

/* 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
#define BEM_INVALID_MD5		3	/* MD5 authentication kernel request failed (possibly not supported */

250

251
252
253
254
255
256
/* 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 */

257
258
259
260
261
262
/* Origins */

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

Martin Mareš's avatar
Martin Mareš committed
263
264
/* Address families */

265
#define BGP_AF_IPV4		1
Martin Mareš's avatar
Martin Mareš committed
266
267
#define BGP_AF_IPV6		2

Martin Mareš's avatar
Martin Mareš committed
268
#endif