]> git.ipfire.org Git - thirdparty/bird.git/blame - proto/bgp/bgp.h
Show command cleanups.
[thirdparty/bird.git] / proto / bgp / bgp.h
CommitLineData
2638249d
MM
1/*
2 * BIRD -- The Border Gateway Protocol
3 *
4 * (c) 2000 Martin Mares <mj@ucw.cz>
5 *
6 * Can be freely distributed and used under the terms of the GNU GPL.
7 */
8
9#ifndef _BIRD_BGP_H_
10#define _BIRD_BGP_H_
11
46eb80d5 12#include <stdint.h>
c2b28c99
MM
13#include "nest/route.h"
14
c00d31be 15struct linpool;
10be74da 16struct eattr;
c00d31be 17
2638249d
MM
18struct bgp_config {
19 struct proto_config c;
11cb6202 20 u32 local_as, remote_as;
2638249d
MM
21 ip_addr remote_ip;
22 int multihop; /* Number of hops if multihop */
c00d31be 23 ip_addr multihop_via; /* Multihop: address to route to */
8b258e4e 24 ip_addr source_addr; /* Source address to use */
48e842cc 25 int next_hop_self; /* Always set next hop to local IP address */
3f9b7bfe 26 int missing_lladdr; /* What we will do when we don' know link-local addr, see MLL_* */
56a2bed4 27 int compare_path_lengths; /* Use path lengths when selecting best route */
3228c72c 28 int prefer_older; /* Prefer older routes according to RFC 5004 */
56a2bed4
MM
29 u32 default_local_pref; /* Default value for LOCAL_PREF attribute */
30 u32 default_med; /* Default value for MULTI_EXIT_DISC attribute */
e8ba557c 31 int capabilities; /* Enable capability handshake [RFC3392] */
bf47fe4b 32 int enable_refresh; /* Enable local support for route refresh [RFC2918] */
ba5ed6f3 33 int enable_as4; /* Enable local support for 4B AS numbers [RFC4893] */
4847a894
OZ
34 u32 rr_cluster_id; /* Route reflector cluster ID, if different from local ID */
35 int rr_client; /* Whether neighbor is RR client of me */
a92fe607 36 int rs_client; /* Whether neighbor is RS client of me */
e3299ab1 37 int advertise_ipv4; /* Whether we should add IPv4 capability advertisement to OPEN message */
72b28a04 38 u32 route_limit; /* Number of routes that may be imported, 0 means disable limit */
be6e39eb 39 int passive; /* Do not initiate outgoing connection */
3fdbafb6
MM
40 unsigned connect_retry_time;
41 unsigned hold_time, initial_hold_time;
42 unsigned keepalive_time;
6fd766c1
MM
43 unsigned start_delay_time; /* Minimum delay between connects */
44 unsigned error_amnesia_time; /* Errors are forgotten after */
45 unsigned error_delay_time_min; /* Time to wait after an error is detected */
46 unsigned error_delay_time_max;
47 unsigned disable_after_error; /* Disable the protocol when error is detected */
d51aa281 48 char *password; /* Password used for MD5 authentication */
c01e3741
MM
49};
50
3f9b7bfe
OZ
51#define MLL_SELF 1
52#define MLL_DROP 2
53#define MLL_IGNORE 3
54
c01e3741
MM
55struct bgp_conn {
56 struct bgp_proto *bgp;
57 struct birdsock *sk;
72a6ef11 58 unsigned int state; /* State of connection state machine */
c01e3741
MM
59 struct timer *connect_retry_timer;
60 struct timer *hold_timer;
61 struct timer *keepalive_timer;
11b32d91 62 struct event *tx_ev;
3fdbafb6 63 int packets_to_send; /* Bitmap of packet types to be sent */
efcece2d
MM
64 int notify_code, notify_subcode, notify_size;
65 byte *notify_data;
11cb6202 66 u32 advertised_as; /* Temporary value for AS number received */
165a6227
OZ
67 int start_state; /* protocol start_state snapshot when connection established */
68 int want_as4_support; /* Connection tries to establish AS4 session */
69 int peer_as4_support; /* Peer supports 4B AS numbers [RFC4893] */
bf47fe4b 70 int peer_refresh_support; /* Peer supports route refresh [RFC2918] */
3fdbafb6 71 unsigned hold_time, keepalive_time; /* Times calculated from my and neighbor's requirements */
2638249d
MM
72};
73
74struct bgp_proto {
75 struct proto p;
c01e3741 76 struct bgp_config *cf; /* Shortcut to BGP configuration */
11cb6202 77 u32 local_as, remote_as;
11b32d91 78 int start_state; /* Substates that partitions BS_START */
c01e3741 79 int is_internal; /* Internal BGP connection (local_as == remote_as) */
ba5ed6f3 80 int as4_session; /* Session uses 4B AS numbers in AS_PATH (both sides support it) */
c01e3741
MM
81 u32 local_id; /* BGP identifier of this router */
82 u32 remote_id; /* BGP identifier of the neighbor */
4847a894
OZ
83 u32 rr_cluster_id; /* Route reflector cluster ID */
84 int rr_client; /* Whether neighbor is RR client of me */
a92fe607 85 int rs_client; /* Whether neighbor is RS client of me */
b552ecc4
MM
86 struct bgp_conn *conn; /* Connection we have established */
87 struct bgp_conn outgoing_conn; /* Outgoing connection we're working with */
c01e3741
MM
88 struct bgp_conn incoming_conn; /* Incoming connection we have neither accepted nor rejected yet */
89 struct object_lock *lock; /* Lock for neighbor connection */
48e842cc
MM
90 ip_addr next_hop; /* Either the peer or multihop_via */
91 struct neighbor *neigh; /* Neighbor entry corresponding to next_hop */
92 ip_addr local_addr; /* Address of the local end of the link to next_hop */
ad440a57 93 ip_addr source_addr; /* Address used as advertised next hop, usually local_addr */
11b32d91 94 struct event *event; /* Event for respawning and shutting process */
dd91e467 95 struct timer *startup_timer; /* Timer used to delay protocol startup due to previous errors (startup_delay) */
c2b28c99 96 struct bgp_bucket **bucket_hash; /* Hash table of attribute buckets */
ae8f5584 97 unsigned int hash_size, hash_count, hash_limit;
c2b28c99
MM
98 struct fib prefix_fib; /* Prefixes to be sent */
99 list bucket_queue; /* Queue of buckets to send */
100 struct bgp_bucket *withdraw_bucket; /* Withdrawn routes */
6fd766c1 101 unsigned startup_delay; /* Time to delay protocol startup by due to errors */
11b32d91
OZ
102 bird_clock_t last_proto_error; /* Time of last error that leads to protocol stop */
103 u8 last_error_class; /* Error class of last error */
104 u32 last_error_code; /* Error code of last error. BGP protocol errors
105 are encoded as (bgp_err_code << 16 | bgp_err_subcode) */
1c1da87b
MM
106#ifdef IPV6
107 byte *mp_reach_start, *mp_unreach_start; /* Multiprotocol BGP attribute notes */
108 unsigned mp_reach_len, mp_unreach_len;
11d4474c 109 ip_addr local_link; /* Link-level version of local_addr */
1c1da87b 110#endif
c2b28c99
MM
111};
112
113struct bgp_prefix {
114 struct fib_node n; /* Node in prefix fib */
115 node bucket_node; /* Node in per-bucket list */
116};
117
118struct bgp_bucket {
c2b28c99 119 node send_node; /* Node in send queue */
f421cfdd 120 struct bgp_bucket *hash_next, *hash_prev; /* Node in bucket hash table */
c2b28c99
MM
121 unsigned hash; /* Hash over extended attributes */
122 list prefixes; /* Prefixes in this buckets */
123 ea_list eattrs[0]; /* Per-bucket extended attributes */
2638249d
MM
124};
125
72a6ef11
MM
126#define BGP_PORT 179
127#define BGP_VERSION 4
128#define BGP_HEADER_LENGTH 19
129#define BGP_MAX_PACKET_LENGTH 4096
130#define BGP_RX_BUFFER_SIZE 4096
131#define BGP_TX_BUFFER_SIZE BGP_MAX_PACKET_LENGTH
2638249d 132
973399ae
MM
133extern struct linpool *bgp_linpool;
134
11cb6202 135
3fdbafb6 136void bgp_start_timer(struct timer *t, int value);
2638249d 137void bgp_check(struct bgp_config *c);
efcece2d 138void bgp_error(struct bgp_conn *c, unsigned code, unsigned subcode, byte *data, int len);
b552ecc4 139void bgp_close_conn(struct bgp_conn *c);
b99d3786 140void bgp_update_startup_delay(struct bgp_proto *p);
11b32d91
OZ
141void bgp_conn_enter_established_state(struct bgp_conn *conn);
142void bgp_conn_enter_close_state(struct bgp_conn *conn);
143void bgp_conn_enter_idle_state(struct bgp_conn *conn);
144void bgp_store_error(struct bgp_proto *p, struct bgp_conn *c, u8 class, u32 code);
72b28a04 145int bgp_apply_limits(struct bgp_proto *p);
b99d3786
OZ
146void bgp_stop(struct bgp_proto *p, unsigned subcode);
147
11b32d91 148
2638249d 149
85368cd4
MM
150#ifdef LOCAL_DEBUG
151#define BGP_FORCE_DEBUG 1
152#else
153#define BGP_FORCE_DEBUG 0
154#endif
155#define BGP_TRACE(flags, msg, args...) do { if ((p->p.debug & flags) || BGP_FORCE_DEBUG) \
156 log(L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
157
cb530392
OZ
158#define BGP_TRACE_RL(rl, flags, msg, args...) do { if ((p->p.debug & flags) || BGP_FORCE_DEBUG) \
159 log_rl(rl, L_TRACE "%s: " msg, p->p.name , ## args ); } while(0)
160
161
c01e3741
MM
162/* attrs.c */
163
4827b69f
OZ
164/* Hack: although BA_NEXT_HOP attribute has type EAF_TYPE_IP_ADDRESS, in IPv6
165 * we store two addesses in it - a global address and a link local address.
166 */
167#ifdef IPV6
168#define NEXT_HOP_LENGTH (2*sizeof(ip_addr))
169static inline void set_next_hop(byte *b, ip_addr addr) { ((ip_addr *) b)[0] = addr; ((ip_addr *) b)[1] = IPA_NONE; }
170#else
171#define NEXT_HOP_LENGTH sizeof(ip_addr)
172static inline void set_next_hop(byte *b, ip_addr addr) { ((ip_addr *) b)[0] = addr; }
173#endif
174
4847a894
OZ
175void bgp_attach_attr(struct ea_list **to, struct linpool *pool, unsigned attr, uintptr_t val);
176byte *bgp_attach_attr_wa(struct ea_list **to, struct linpool *pool, unsigned attr, unsigned len);
2a9e064d 177struct rta *bgp_decode_attrs(struct bgp_conn *conn, byte *a, unsigned int len, struct linpool *pool, int mandatory);
aebe06b4 178int bgp_get_attr(struct eattr *e, byte *buf, int buflen);
ef2c708d
MM
179int bgp_rte_better(struct rte *, struct rte *);
180void bgp_rt_notify(struct proto *, struct network *, struct rte *, struct rte *, struct ea_list *);
181int bgp_import_control(struct proto *, struct rte **, struct ea_list **, struct linpool *);
ae8f5584 182void bgp_attr_init(struct bgp_proto *);
11cb6202 183unsigned int bgp_encode_attrs(struct bgp_proto *p, byte *w, ea_list *attrs, int remains);
f421cfdd 184void bgp_free_bucket(struct bgp_proto *p, struct bgp_bucket *buck);
5e88d730 185void bgp_get_route_info(struct rte *, byte *buf, struct ea_list *attrs);
c00d31be 186
4847a894
OZ
187inline static void bgp_attach_attr_ip(struct ea_list **to, struct linpool *pool, unsigned attr, ip_addr a)
188{ *(ip_addr *) bgp_attach_attr_wa(to, pool, attr, sizeof(ip_addr)) = a; }
189
c01e3741
MM
190/* packets.c */
191
72a6ef11 192void bgp_schedule_packet(struct bgp_conn *conn, int type);
11b32d91 193void bgp_kick_tx(void *vconn);
72a6ef11
MM
194void bgp_tx(struct birdsock *sk);
195int bgp_rx(struct birdsock *sk, int size);
11b32d91 196const byte * bgp_error_dsc(byte *buff, unsigned code, unsigned subcode);
b99d3786 197void bgp_log_error(struct bgp_proto *p, u8 class, char *msg, unsigned code, unsigned subcode, byte *data, unsigned len);
72a6ef11 198
c01e3741
MM
199/* Packet types */
200
201#define PKT_OPEN 0x01
202#define PKT_UPDATE 0x02
203#define PKT_NOTIFICATION 0x03
204#define PKT_KEEPALIVE 0x04
bf47fe4b 205#define PKT_ROUTE_REFRESH 0x05
72a6ef11 206#define PKT_SCHEDULE_CLOSE 0x1f /* Used internally to schedule socket close */
c01e3741
MM
207
208/* Attributes */
209
210#define BAF_OPTIONAL 0x80
211#define BAF_TRANSITIVE 0x40
212#define BAF_PARTIAL 0x20
213#define BAF_EXT_LEN 0x10
214
215#define BA_ORIGIN 0x01 /* [RFC1771] */ /* WM */
216#define BA_AS_PATH 0x02 /* WM */
217#define BA_NEXT_HOP 0x03 /* WM */
218#define BA_MULTI_EXIT_DISC 0x04 /* ON */
c00d31be 219#define BA_LOCAL_PREF 0x05 /* WD */
c01e3741
MM
220#define BA_ATOMIC_AGGR 0x06 /* WD */
221#define BA_AGGREGATOR 0x07 /* OT */
222#define BA_COMMUNITY 0x08 /* [RFC1997] */ /* OT */
223#define BA_ORIGINATOR_ID 0x09 /* [RFC1966] */ /* ON */
224#define BA_CLUSTER_LIST 0x0a /* ON */
225/* We don't support these: */
226#define BA_DPA 0x0b /* ??? */
227#define BA_ADVERTISER 0x0c /* [RFC1863] */
228#define BA_RCID_PATH 0x0d
229#define BA_MP_REACH_NLRI 0x0e /* [RFC2283] */
230#define BA_MP_UNREACH_NLRI 0x0f
231#define BA_EXTENDED_COMM 0x10 /* draft-ramachandra-bgp-ext-communities */
11cb6202
OZ
232#define BA_AS4_PATH 0x11 /* [RFC4893] */
233#define BA_AS4_AGGREGATOR 0x12
c01e3741 234
11b32d91 235/* BGP connection states */
c01e3741
MM
236
237#define BS_IDLE 0
238#define BS_CONNECT 1 /* Attempting to connect */
239#define BS_ACTIVE 2 /* Waiting for connection retry & listening */
240#define BS_OPENSENT 3
241#define BS_OPENCONFIRM 4
242#define BS_ESTABLISHED 5
11b32d91
OZ
243#define BS_CLOSE 6 /* Used during transition to BS_IDLE */
244
245/* BGP start states
246 *
247 * Used in PS_START for fine-grained specification of starting state.
248 *
249 * When BGP protocol is started by core, it goes to BSS_PREPARE. When BGP protocol
250 * done what is neccessary to start itself (like acquiring the lock), it goes to BSS_CONNECT.
251 * When some connection attempt failed because of option or capability error, it goes to
252 * BSS_CONNECT_NOCAP.
253 */
254
255#define BSS_PREPARE 0 /* Used before ordinary BGP started, i. e. waiting for lock */
dd91e467
OZ
256#define BSS_DELAY 1 /* Startup delay due to previous errors */
257#define BSS_CONNECT 2 /* Ordinary BGP connecting */
258#define BSS_CONNECT_NOCAP 3 /* Legacy BGP connecting (without capabilities) */
11b32d91
OZ
259
260/* Error classes */
261
262#define BE_NONE 0
263#define BE_MISC 1 /* Miscellaneous error */
264#define BE_SOCKET 2 /* Socket error */
265#define BE_BGP_RX 3 /* BGP protocol error notification received */
266#define BE_BGP_TX 4 /* BGP protocol error notification sent */
267#define BE_AUTO_DOWN 5 /* Automatic shutdown */
268#define BE_MAN_DOWN 6 /* Manual shutdown */
269
270/* Misc error codes */
271
272#define BEM_NEIGHBOR_LOST 1
273#define BEM_INVALID_NEXT_HOP 2
72b28a04 274#define BEM_INVALID_MD5 3 /* MD5 authentication kernel request failed (possibly not supported) */
11b32d91 275
72b28a04
OZ
276/* Automatic shutdown error codes */
277
278#define BEA_ROUTE_LIMIT_EXCEEDED 1
c01e3741 279
bd2d8190
MM
280/* Well-known communities */
281
282#define BGP_COMM_NO_EXPORT 0xffffff01 /* Don't export outside local AS / confed. */
283#define BGP_COMM_NO_ADVERTISE 0xffffff02 /* Don't export at all */
284#define BGP_COMM_NO_EXPORT_SUBCONFED 0xffffff03 /* NO_EXPORT even in local confederation */
285
cea63664
MM
286/* Origins */
287
288#define ORIGIN_IGP 0
289#define ORIGIN_EGP 1
290#define ORIGIN_INCOMPLETE 2
291
1c1da87b
MM
292/* Address families */
293
e3299ab1 294#define BGP_AF_IPV4 1
1c1da87b
MM
295#define BGP_AF_IPV6 2
296
2638249d 297#endif