summaryrefslogtreecommitdiff
path: root/usr.sbin/bgpd/mrt.h
blob: a7e6381a03e835dbfda2289f1cd3779754e7961a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*	$OpenBSD: mrt.h,v 1.6 2004/01/02 00:13:32 deraadt Exp $ */

/*
 * Copyright (c) 2003 Claudio Jeker <cjeker@diehard.n-r-g.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#ifndef __MRT_H__
#define __MRT_H__

#include "bgpd.h"

/*
 * MRT binary packet format as used by zebra.
 * For more info see:
 * http://www.mrtd.net/mrt_doc/html/mrtprogrammer.html#_Toc412283890
 * or
 * http://www.mrtd.net/mrt_doc/PDF/mrtprogrammer.pdf (Chapter 12)
 * and
 * http://www.quagga.net/docs/docs-multi/Packet-Binary-Dump-Format.html
 */

struct mrt_header {
	u_int32_t	timestamp;
	u_int16_t	type;
	u_int16_t	subtype;
	u_int32_t	length;		/* length of packet including header */
};

enum MRT_MSG_TYPES {
	MSG_NULL,
	MSG_START,		/*  1 sender is starting up */
	MSG_DIE,		/*  2 receiver should shut down */
	MSG_I_AM_DEAD,		/*  3 sender is shutting down */
	MSG_PEER_DOWN,		/*  4 sender's peer is down */
	MSG_PROTOCOL_BGP,	/*  5 msg is a BGP packet */
	MSG_PROTOCOL_RIP,	/*  6 msg is a RIP packet */
	MSG_PROTOCOL_IDRP,	/*  7 msg is an IDRP packet */
	MSG_PROTOCOL_RIPNG,	/*  8 msg is a RIPNG packet */
	MSG_PROTOCOL_BGP4PLUS,	/*  9 msg is a BGP4+ packet */
	MSG_PROTOCOL_BGP4PLUS1,	/* 10 msg is a BGP4+ (draft 01) packet */
	MSG_PROTOCOL_OSPF,	/* 11 msg is an OSPF packet */
	MSG_TABLE_DUMP,		/* 12 routing table dump */
	MSG_PROTOCOL_BGP4MP=16	/* 16 zebras own packet format */
};

#define MRT_HEADER_SIZE		sizeof(struct mrt_header)
#define MRT_DUMP_HEADER_SIZE	22	/* sizeof(struct mrt_dump_v4_header) */
#define MRT_BGP4MP_HEADER_SIZE	\
	sizeof(struct mrt_bgp4mp_header) + \
	sizeof(struct mrt_bgp4mp_IPv4)
/*
 * format for routing table dumps in mrt format.
 * Type MSG_TABLE_DUMP and subtype is address family (IPv4)
 */
struct mrt_dump_v4_header {
	u_int16_t	view;	/* normally 0 */
	u_int16_t	seqnum;	/* simple counter for this dump */
	u_int32_t	prefix;
	u_int8_t	prefixlen;
	u_int8_t	status;	/* default seems to be 1 */
	u_int32_t	originated; /* seems to be time of last update */
	u_int32_t	peer_ip;
	u_int16_t	peer_as;
	u_int16_t	attr_len;
	/* bgp attributes attr_len bytes long */
};

/*
 * format for routing table dumps in mrt format.
 * Type MSG_TABLE_DUMP and subtype is address family (IPv6)
 */
struct mrt_dump_v6_header {
	u_int16_t	view;	/* normally 0 */
	u_int16_t	seqnum;	/* simple counter for this dump */
	u_int32_t	prefix[4];
	u_int8_t	prefixlen;
	u_int8_t	status;	/* default seems to be 1 */
	u_int32_t	originated; /* seems to be time of last update */
	u_int32_t	peer_ip[4];
	u_int16_t	peer_as;
	u_int16_t	attr_len;
	/* bgp attributes attr_len bytes long */
};



/*
 * Main zebra dump format is in MSG_PROTOCOL_BGP4MP exceptions are table dumps
 * that are normaly saved as MSG_TABLE_DUMP.
 * In most cases this is the format to choose to dump updates et al.
 */
enum MRT_BGP4MP_TYPES {
	BGP4MP_STATE_CHANGE=0,	/* state change */
	BGP4MP_MESSAGE=1,	/* bgp message */
	BGP4MP_ENTRY=2,		/* table dumps */
	BGP4MP_SNAPSHOT=3
};

/* if type PROTOCOL_BGP4MP and
 * subtype BGP4MP_STATE_CHANGE or BGP4MP_MESSAGE  */
struct mrt_bgp4mp_header {
	u_int16_t	source_as;
	u_int16_t	dest_as;
	u_int16_t	if_index;
	u_int16_t	afi;
	/*
	 * Next comes either a struct mrt_bgp4mp_IPv4 or a
	 * struct mrt_bgp4mp_IPv6 dependent on afi type.
	 *
	 * Last but not least the payload.
	 */
};

/* if afi = 4 */
struct mrt_bgp4mp_IPv4 {
	u_int32_t	source_ip;
	u_int32_t	dest_ip;
};

/* if afi = 6 */
struct mrt_bgp4mp_IPv6 {
	u_int32_t	source_ip[4];
	u_int32_t	dest_ip[4];
};

/*
 * payload of a BGP4MP_STATE_CHANGE packet
 */
struct mrt_bgp4mp_state_data {
	u_int16_t	old_state;	/* as in RFC 1771 */
	u_int16_t	new_state;
};

/*
 * The payload of a BGP4MP_MESSAGE is the full bgp message with header.
 */

/* if type PROTOCOL_BGP4MP, subtype BGP4MP_ENTRY */
struct mrt_bgp4mp_entry_header {
	u_int16_t	view;
	u_int16_t	status;
	u_int32_t	originated;	/* time last change */
	u_int16_t	afi;
	u_int8_t	safi;
	u_int8_t	nexthop_len;
	/*
	 * u_int32_t nexthop    for IPv4 or
	 * u_int32_t nexthop[4] for IPv6
	 * u_int8_t  prefixlen
	 * variable prefix (prefixlen bits long rounded to the next octet)
	 * u_int16_t attrlen
	 * variable length bgp attributes attrlen bytes long
	 */
};

/*
 * What is this for?
 * if type MSG_PROTOCOL_BGP and subtype MSG_BGP_SYNC OR
 * if type MSG_PROTOCOL_BGP4MP and subtype BGP4MP_SNAPSHOT
 */
struct mrt_bgp_sync_header {
	u_int16_t	view;
	char		filename[2]; /* variable */
};

/*
 * OLD MRT message headers. These structs are here for completion but
 * will not be used to generate dumps. It seems that nobody uses those.
 */

/*
 * Only for bgp messages (type 5, 9 and 10)
 * Nota bene for bgp dumps MSG_PROTOCOL_BGP4MP should be used.
 */
enum MRT_BGP_TYPES {
	MSG_BGP_NULL,
	MSG_BGP_UPDATE,		/* raw update packet (contains both withdraws
				   and announcements) */
	MSG_BGP_PREF_UPDATE,	/* tlv preferences followed by raw update */
	MSG_BGP_STATE_CHANGE,	/* state change */
	MSG_BGP_SYNC
};

/* if type MSG_PROTOCOL_BGP and subtype MSG_BGP_UPDATE */
struct mrt_bgp_update_header {
	u_int16_t	source_as;
	u_int32_t	source_ip;
	u_int16_t	dest_as;
	u_int32_t	dest_ip;
	/* bgp update packet */
};

/* if type MSG_PROTOCOL_BGP4PLUS and subtype MSG_BGP_UPDATE */
struct mrt_bgp_update_plus_header {
	u_int16_t	source_as;
	u_int32_t	source_ip[4];
	u_int16_t	dest_as;
	u_int32_t	dest_ip[4];
	/* bgp update packet */
};

/* for subtype MSG_BGP_STATECHANGE (for all BGP types ???) */
struct mrt_bgp_state_header {
	u_int16_t	source_as;
	u_int32_t	source_ip[4];
	u_int16_t	old_state;	/* as in RFC 1771 ??? */
	u_int16_t	new_state;
};

/* pseudo predeclarations */
struct prefix;
struct pt_entry;
struct mrt {
	struct msgbuf	*msgbuf;
	u_int32_t	 id;
};

/* prototypes */
int	mrt_dump_bgp_msg(struct mrt *, void *, u_int16_t, int,
    struct peer_config *, struct bgpd_config *);
void	mrt_clear_seq(void);
void	mrt_dump_upcall(struct pt_entry *, void *);
int	mrt_state(struct mrtdump_config *, enum imsg_type, struct imsgbuf *);
int	mrt_alrm(struct mrt_config *, struct imsgbuf *);
int	mrt_usr1(struct mrt_config *, struct imsgbuf *);

#endif