packet.h 16.0 KB
Newer Older
1
/* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
2 3 4 5 6 7 8 9 10 11 12 13 14
 *
 * Marek Lindner, Simon Wunderlich
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
15
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20
 */

#ifndef _NET_BATMAN_ADV_PACKET_H_
#define _NET_BATMAN_ADV_PACKET_H_

21 22
/**
 * enum batadv_packettype - types for batman-adv encapsulated packets
23 24 25 26 27 28 29 30 31 32
 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
 * @BATADV_BCAST: broadcast packets carrying broadcast payload
 * @BATADV_CODED: network coded packets
 *
 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
 *     payload packet
 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
 *     the sender
 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
33 34
 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
 */
35
enum batadv_packettype {
36 37 38 39 40 41 42 43 44 45 46 47 48
	/* 0x00 - 0x3f: local packets or special rules for handling */
	BATADV_IV_OGM           = 0x00,
	BATADV_BCAST            = 0x01,
	BATADV_CODED            = 0x02,
	/* 0x40 - 0x7f: unicast */
#define BATADV_UNICAST_MIN     0x40
	BATADV_UNICAST          = 0x40,
	BATADV_UNICAST_FRAG     = 0x41,
	BATADV_UNICAST_4ADDR    = 0x42,
	BATADV_ICMP             = 0x43,
	BATADV_UNICAST_TVLV     = 0x44,
#define BATADV_UNICAST_MAX     0x7f
	/* 0x80 - 0xff: reserved */
49 50 51 52 53
};

/**
 * enum batadv_subtype - packet subtype for unicast4addr
 * @BATADV_P_DATA: user payload
54 55 56
 * @BATADV_P_DAT_DHT_GET: DHT request message
 * @BATADV_P_DAT_DHT_PUT: DHT store message
 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
57 58
 */
enum batadv_subtype {
59 60 61 62
	BATADV_P_DATA			= 0x01,
	BATADV_P_DAT_DHT_GET		= 0x02,
	BATADV_P_DAT_DHT_PUT		= 0x03,
	BATADV_P_DAT_CACHE_REPLY	= 0x04,
63
};
64 65

/* this file is included by batctl which needs these defines */
66
#define BATADV_COMPAT_VERSION 15
67

68 69 70 71 72 73 74 75 76
/**
 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
 *     previously received from someone else than the best neighbor.
 * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
 *     is used, and the packet travels its first hop.
 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
 *     one hop neighbor on the interface where it was originally received.
 */
77
enum batadv_iv_flags {
78 79 80
	BATADV_NOT_BEST_NEXT_HOP   = BIT(0),
	BATADV_PRIMARIES_FIRST_HOP = BIT(1),
	BATADV_DIRECTLINK          = BIT(2),
81
};
82 83

/* ICMP message types */
84 85 86 87 88 89
enum batadv_icmp_packettype {
	BATADV_ECHO_REPLY	       = 0,
	BATADV_DESTINATION_UNREACHABLE = 3,
	BATADV_ECHO_REQUEST	       = 8,
	BATADV_TTL_EXCEEDED	       = 11,
	BATADV_PARAMETER_PROBLEM       = 12,
90
};
91

92 93
/* tt data subtypes */
#define BATADV_TT_DATA_TYPE_MASK 0x0F
94

95 96 97 98 99 100 101 102 103 104 105 106
/**
 * enum batadv_tt_data_flags - flags for tt data tvlv
 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
 * @BATADV_TT_REQUEST: TT request message
 * @BATADV_TT_RESPONSE: TT response message
 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
 */
enum batadv_tt_data_flags {
	BATADV_TT_OGM_DIFF   = BIT(0),
	BATADV_TT_REQUEST    = BIT(1),
	BATADV_TT_RESPONSE   = BIT(2),
	BATADV_TT_FULL_TABLE = BIT(4),
107 108
};

109
/* BATADV_TT_CLIENT flags.
110
 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
111 112
 * BIT(15) are used for local computation only.
 * Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network.
113
 */
114
enum batadv_tt_client_flags {
115 116
	BATADV_TT_CLIENT_DEL     = BIT(0),
	BATADV_TT_CLIENT_ROAM    = BIT(1),
117
	BATADV_TT_CLIENT_WIFI    = BIT(4),
118 119 120
	BATADV_TT_CLIENT_NOPURGE = BIT(8),
	BATADV_TT_CLIENT_NEW     = BIT(9),
	BATADV_TT_CLIENT_PENDING = BIT(10),
121
	BATADV_TT_CLIENT_TEMP	 = BIT(11),
122 123
};

124 125 126 127 128 129 130 131
/**
 * batadv_vlan_flags - flags for the four MSB of any vlan ID field
 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
 */
enum batadv_vlan_flags {
	BATADV_VLAN_HAS_TAG	= BIT(15),
};

132
/* claim frame types for the bridge loop avoidance */
133
enum batadv_bla_claimframe {
134 135
	BATADV_CLAIM_TYPE_CLAIM		= 0x00,
	BATADV_CLAIM_TYPE_UNCLAIM	= 0x01,
136 137
	BATADV_CLAIM_TYPE_ANNOUNCE	= 0x02,
	BATADV_CLAIM_TYPE_REQUEST	= 0x03,
138 139
};

140 141 142
/**
 * enum batadv_tvlv_type - tvlv type definitions
 * @BATADV_TVLV_GW: gateway tvlv
143
 * @BATADV_TVLV_DAT: distributed arp table tvlv
144
 * @BATADV_TVLV_NC: network coding tvlv
145
 * @BATADV_TVLV_TT: translation table tvlv
146
 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
147 148 149
 */
enum batadv_tvlv_type {
	BATADV_TVLV_GW		= 0x01,
150
	BATADV_TVLV_DAT		= 0x02,
151
	BATADV_TVLV_NC		= 0x03,
152
	BATADV_TVLV_TT		= 0x04,
153
	BATADV_TVLV_ROAM	= 0x05,
154 155
};

156
#pragma pack(2)
157 158 159
/* the destination hardware field in the ARP frame is used to
 * transport the claim type and the group id
 */
160
struct batadv_bla_claim_dst {
161 162
	uint8_t magic[3];	/* FF:43:05 */
	uint8_t type;		/* bla_claimframe */
163
	__be16 group;		/* group id */
164
};
165
#pragma pack()
166

167 168
/**
 * struct batadv_ogm_packet - ogm (routing protocol) packet
169 170 171
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
172
 * @flags: contains routing relevant flags - see enum batadv_iv_flags
173 174
 * @tvlv_len: length of tvlv data following the ogm header
 */
175
struct batadv_ogm_packet {
176 177 178
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
179
	uint8_t  flags;
180
	__be32   seqno;
181 182
	uint8_t  orig[ETH_ALEN];
	uint8_t  prev_sender[ETH_ALEN];
183
	uint8_t  reserved;
184
	uint8_t  tq;
185
	__be16   tvlv_len;
186 187 188 189
	/* __packed is not needed as the struct size is divisible by 4,
	 * and the largest data type in this struct has a size of 4.
	 */
};
190

191
#define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
192

193
/**
194
 * batadv_icmp_header - common members among all the ICMP packets
195 196 197
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
198 199 200 201
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
202 203 204 205 206
 * @align: not used - useful for alignment purposes only
 *
 * This structure is used for ICMP packets parsing only and it is never sent
 * over the wire. The alignment field at the end is there to ensure that
 * members are padded the same way as they are in real packets.
207 208
 */
struct batadv_icmp_header {
209 210 211
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
212
	uint8_t  msg_type; /* see ICMP message types above */
213 214
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
215
	uint8_t  uid;
216
	uint8_t  align[3];
217 218 219 220
};

/**
 * batadv_icmp_packet - ICMP packet
221 222 223 224 225 226 227
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
228 229 230 231
 * @reserved: not used - useful for alignment
 * @seqno: ICMP sequence number
 */
struct batadv_icmp_packet {
232 233 234 235 236 237 238
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	uint8_t  uid;
239
	uint8_t  reserved;
240
	__be16   seqno;
241
};
242

243
#define BATADV_RR_LEN 16
244

245 246
/**
 * batadv_icmp_packet_rr - ICMP RouteRecord packet
247 248 249 250 251 252 253
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @msg_type: ICMP packet type
 * @dst: address of the destination node
 * @orig: address of the source node
 * @uid: local ICMP socket identifier
254 255 256
 * @rr_cur: number of entries the rr array
 * @seqno: ICMP sequence number
 * @rr: route record array
257
 */
258
struct batadv_icmp_packet_rr {
259 260 261 262 263 264 265
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
	uint8_t  msg_type; /* see ICMP message types above */
	uint8_t  dst[ETH_ALEN];
	uint8_t  orig[ETH_ALEN];
	uint8_t  uid;
266
	uint8_t  rr_cur;
267
	__be16   seqno;
268
	uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
269
};
270

271 272
#define BATADV_ICMP_MAX_PACKET_SIZE	sizeof(struct batadv_icmp_packet_rr)

273 274 275 276 277 278 279 280 281 282 283 284
/* All packet headers in front of an ethernet header have to be completely
 * divisible by 2 but not by 4 to make the payload after the ethernet
 * header again 4 bytes boundary aligned.
 *
 * A packing of 2 is necessary to avoid extra padding at the end of the struct
 * caused by a structure member which is larger than two bytes. Otherwise
 * the structure would not fulfill the previously mentioned rule to avoid the
 * misalignment of the payload after the ethernet header. It may also lead to
 * leakage of information when the padding it not initialized before sending.
 */
#pragma pack(2)

285 286 287 288 289 290 291 292
/**
 * struct batadv_unicast_packet - unicast packet for network payload
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @ttvn: translation table version number
 * @dest: originator destination of the unicast packet
 */
293
struct batadv_unicast_packet {
294 295 296
	uint8_t  packet_type;
	uint8_t  version;
	uint8_t  ttl;
297
	uint8_t  ttvn; /* destination translation table version number */
298
	uint8_t  dest[ETH_ALEN];
299 300 301 302
	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	 * following ethernet header again 4 bytes boundary aligned
	 */
};
303

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
/**
 * struct batadv_unicast_4addr_packet - extended unicast packet
 * @u: common unicast packet header
 * @src: address of the source
 * @subtype: packet subtype
 */
struct batadv_unicast_4addr_packet {
	struct batadv_unicast_packet u;
	uint8_t src[ETH_ALEN];
	uint8_t subtype;
	uint8_t reserved;
	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	 * following ethernet header again 4 bytes boundary aligned
	 */
};

320 321
/**
 * struct batadv_frag_packet - fragmented packet
322 323 324
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
325 326 327 328 329 330 331 332
 * @dest: final destination used when routing fragments
 * @orig: originator of the fragment used when merging the packet
 * @no: fragment number within this sequence
 * @reserved: reserved byte for alignment
 * @seqno: sequence identification
 * @total_size: size of the merged packet
 */
struct batadv_frag_packet {
333 334 335
	uint8_t packet_type;
	uint8_t version;  /* batman version field */
	uint8_t ttl;
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
#if defined(__BIG_ENDIAN_BITFIELD)
	uint8_t no:4;
	uint8_t reserved:4;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	uint8_t reserved:4;
	uint8_t no:4;
#else
#error "unknown bitfield endianess"
#endif
	uint8_t dest[ETH_ALEN];
	uint8_t orig[ETH_ALEN];
	__be16  seqno;
	__be16  total_size;
};

351 352 353 354 355 356 357 358 359
/**
 * struct batadv_bcast_packet - broadcast packet for network payload
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
 * @reserved: reserved byte for alignment
 * @seqno: sequence identification
 * @orig: originator of the broadcast packet
 */
360
struct batadv_bcast_packet {
361 362 363
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
364
	uint8_t  reserved;
365
	__be32   seqno;
366
	uint8_t  orig[ETH_ALEN];
367 368 369
	/* "4 bytes boundary + 2 bytes" long to make the payload after the
	 * following ethernet header again 4 bytes boundary aligned
	 */
370 371
};

372 373
/**
 * struct batadv_coded_packet - network coded packet
374 375 376
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
377 378 379 380 381 382 383 384 385 386 387 388 389 390
 * @reserved: Align following fields to 2-byte boundaries
 * @first_source: original source of first included packet
 * @first_orig_dest: original destinal of first included packet
 * @first_crc: checksum of first included packet
 * @first_ttvn: tt-version number of first included packet
 * @second_ttl: ttl of second packet
 * @second_dest: second receiver of this coded packet
 * @second_source: original source of second included packet
 * @second_orig_dest: original destination of second included packet
 * @second_crc: checksum of second included packet
 * @second_ttvn: tt version number of second included packet
 * @coded_len: length of network coded part of the payload
 */
struct batadv_coded_packet {
391 392 393
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
394 395 396 397 398 399 400 401 402 403 404
	uint8_t  first_ttvn;
	/* uint8_t  first_dest[ETH_ALEN]; - saved in mac header destination */
	uint8_t  first_source[ETH_ALEN];
	uint8_t  first_orig_dest[ETH_ALEN];
	__be32   first_crc;
	uint8_t  second_ttl;
	uint8_t  second_ttvn;
	uint8_t  second_dest[ETH_ALEN];
	uint8_t  second_source[ETH_ALEN];
	uint8_t  second_orig_dest[ETH_ALEN];
	__be32   second_crc;
405
	__be16   coded_len;
406 407
};

408 409
#pragma pack()

410 411
/**
 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
412 413 414
 * @packet_type: batman-adv packet type, part of the general header
 * @version: batman-adv protocol version, part of the genereal header
 * @ttl: time to live for this packet, part of the genereal header
415 416 417 418 419 420 421
 * @reserved: reserved field (for packet alignment)
 * @src: address of the source
 * @dst: address of the destination
 * @tvlv_len: length of tvlv data following the unicast tvlv header
 * @align: 2 bytes to align the header to a 4 byte boundry
 */
struct batadv_unicast_tvlv_packet {
422 423 424
	uint8_t  packet_type;
	uint8_t  version;  /* batman version field */
	uint8_t  ttl;
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
	uint8_t  reserved;
	uint8_t  dst[ETH_ALEN];
	uint8_t  src[ETH_ALEN];
	__be16   tvlv_len;
	uint16_t align;
};

/**
 * struct batadv_tvlv_hdr - base tvlv header struct
 * @type: tvlv container type (see batadv_tvlv_type)
 * @version: tvlv container version
 * @len: tvlv container length
 */
struct batadv_tvlv_hdr {
	uint8_t type;
	uint8_t version;
	__be16  len;
};

444 445 446 447 448 449 450 451 452 453 454
/**
 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
 *  container
 * @bandwidth_down: advertised uplink download bandwidth
 * @bandwidth_up: advertised uplink upload bandwidth
 */
struct batadv_tvlv_gateway_data {
	__be32 bandwidth_down;
	__be32 bandwidth_up;
};

455 456 457 458
/**
 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
 * @flags: translation table flags (see batadv_tt_data_flags)
 * @ttvn: translation table version number
459 460
 * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
 *  one batadv_tvlv_tt_vlan_data object per announced vlan
461 462 463 464
 */
struct batadv_tvlv_tt_data {
	uint8_t flags;
	uint8_t ttvn;
465 466 467 468 469 470 471 472 473 474 475 476 477
	__be16  num_vlan;
};

/**
 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
 *  the tt tvlv container
 * @crc: crc32 checksum of the entries belonging to this vlan
 * @vid: vlan identifier
 * @reserved: unused, useful for alignment purposes
 */
struct batadv_tvlv_tt_vlan_data {
	__be32	crc;
	__be16	vid;
478
	uint16_t reserved;
479 480 481 482 483 484
};

/**
 * struct batadv_tvlv_tt_change - translation table diff data
 * @flags: status indicators concerning the non-mesh client (see
 *  batadv_tt_client_flags)
485
 * @reserved: reserved field - useful for alignment purposes only
486
 * @addr: mac address of non-mesh client that triggered this tt change
487
 * @vid: VLAN identifier
488 489 490
 */
struct batadv_tvlv_tt_change {
	uint8_t flags;
491
	uint8_t reserved[3];
492
	uint8_t addr[ETH_ALEN];
493
	__be16 vid;
494 495
};

496 497 498
/**
 * struct batadv_tvlv_roam_adv - roaming advertisement
 * @client: mac address of roaming client
499
 * @vid: VLAN identifier
500 501 502
 */
struct batadv_tvlv_roam_adv {
	uint8_t  client[ETH_ALEN];
503
	__be16 vid;
504 505
};

506
#endif /* _NET_BATMAN_ADV_PACKET_H_ */