1 /* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 #ifndef _NET_BATMAN_ADV_PACKET_H_
21 #define _NET_BATMAN_ADV_PACKET_H_
24 * enum batadv_packettype - types for batman-adv encapsulated packets
25 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
26 * @BATADV_BCAST: broadcast packets carrying broadcast payload
27 * @BATADV_CODED: network coded packets
29 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
30 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
32 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
34 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
35 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
37 enum batadv_packettype {
38 /* 0x00 - 0x3f: local packets or special rules for handling */
42 /* 0x40 - 0x7f: unicast */
43 #define BATADV_UNICAST_MIN 0x40
44 BATADV_UNICAST = 0x40,
45 BATADV_UNICAST_FRAG = 0x41,
46 BATADV_UNICAST_4ADDR = 0x42,
48 BATADV_UNICAST_TVLV = 0x44,
49 #define BATADV_UNICAST_MAX 0x7f
50 /* 0x80 - 0xff: reserved */
54 * enum batadv_subtype - packet subtype for unicast4addr
55 * @BATADV_P_DATA: user payload
56 * @BATADV_P_DAT_DHT_GET: DHT request message
57 * @BATADV_P_DAT_DHT_PUT: DHT store message
58 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
62 BATADV_P_DAT_DHT_GET = 0x02,
63 BATADV_P_DAT_DHT_PUT = 0x03,
64 BATADV_P_DAT_CACHE_REPLY = 0x04,
67 /* this file is included by batctl which needs these defines */
68 #define BATADV_COMPAT_VERSION 15
71 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
72 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
73 * previously received from someone else than the best neighbor.
74 * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
75 * is used, and the packet travels its first hop.
76 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
77 * one hop neighbor on the interface where it was originally received.
79 enum batadv_iv_flags {
80 BATADV_NOT_BEST_NEXT_HOP = BIT(0),
81 BATADV_PRIMARIES_FIRST_HOP = BIT(1),
82 BATADV_DIRECTLINK = BIT(2),
85 /* ICMP message types */
86 enum batadv_icmp_packettype {
87 BATADV_ECHO_REPLY = 0,
88 BATADV_DESTINATION_UNREACHABLE = 3,
89 BATADV_ECHO_REQUEST = 8,
90 BATADV_TTL_EXCEEDED = 11,
91 BATADV_PARAMETER_PROBLEM = 12,
94 /* tt data subtypes */
95 #define BATADV_TT_DATA_TYPE_MASK 0x0F
98 * enum batadv_tt_data_flags - flags for tt data tvlv
99 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
100 * @BATADV_TT_REQUEST: TT request message
101 * @BATADV_TT_RESPONSE: TT response message
102 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
104 enum batadv_tt_data_flags {
105 BATADV_TT_OGM_DIFF = BIT(0),
106 BATADV_TT_REQUEST = BIT(1),
107 BATADV_TT_RESPONSE = BIT(2),
108 BATADV_TT_FULL_TABLE = BIT(4),
111 /* BATADV_TT_CLIENT flags.
112 * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
113 * BIT(15) are used for local computation only.
114 * Flags from BIT(4) to BIT(7) are kept in sync with the rest of the network.
116 enum batadv_tt_client_flags {
117 BATADV_TT_CLIENT_DEL = BIT(0),
118 BATADV_TT_CLIENT_ROAM = BIT(1),
119 BATADV_TT_CLIENT_WIFI = BIT(4),
120 BATADV_TT_CLIENT_NOPURGE = BIT(8),
121 BATADV_TT_CLIENT_NEW = BIT(9),
122 BATADV_TT_CLIENT_PENDING = BIT(10),
123 BATADV_TT_CLIENT_TEMP = BIT(11),
127 * batadv_vlan_flags - flags for the four MSB of any vlan ID field
128 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
130 enum batadv_vlan_flags {
131 BATADV_VLAN_HAS_TAG = BIT(15),
134 /* claim frame types for the bridge loop avoidance */
135 enum batadv_bla_claimframe {
136 BATADV_CLAIM_TYPE_CLAIM = 0x00,
137 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
138 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
139 BATADV_CLAIM_TYPE_REQUEST = 0x03,
143 * enum batadv_tvlv_type - tvlv type definitions
144 * @BATADV_TVLV_GW: gateway tvlv
145 * @BATADV_TVLV_DAT: distributed arp table tvlv
146 * @BATADV_TVLV_NC: network coding tvlv
147 * @BATADV_TVLV_TT: translation table tvlv
148 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
150 enum batadv_tvlv_type {
151 BATADV_TVLV_GW = 0x01,
152 BATADV_TVLV_DAT = 0x02,
153 BATADV_TVLV_NC = 0x03,
154 BATADV_TVLV_TT = 0x04,
155 BATADV_TVLV_ROAM = 0x05,
158 /* the destination hardware field in the ARP frame is used to
159 * transport the claim type and the group id
161 struct batadv_bla_claim_dst {
162 uint8_t magic[3]; /* FF:43:05 */
163 uint8_t type; /* bla_claimframe */
164 __be16 group; /* group id */
168 * struct batadv_ogm_packet - ogm (routing protocol) packet
169 * @packet_type: batman-adv packet type, part of the general header
170 * @version: batman-adv protocol version, part of the genereal header
171 * @ttl: time to live for this packet, part of the genereal header
172 * @flags: contains routing relevant flags - see enum batadv_iv_flags
173 * @tvlv_len: length of tvlv data following the ogm header
175 struct batadv_ogm_packet {
181 uint8_t orig[ETH_ALEN];
182 uint8_t prev_sender[ETH_ALEN];
186 /* __packed is not needed as the struct size is divisible by 4,
187 * and the largest data type in this struct has a size of 4.
191 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
194 * batadv_icmp_header - common ICMP header
195 * @packet_type: batman-adv packet type, part of the general header
196 * @version: batman-adv protocol version, part of the genereal header
197 * @ttl: time to live for this packet, part of the genereal header
198 * @msg_type: ICMP packet type
199 * @dst: address of the destination node
200 * @orig: address of the source node
201 * @uid: local ICMP socket identifier
203 struct batadv_icmp_header {
207 uint8_t msg_type; /* see ICMP message types above */
208 uint8_t dst[ETH_ALEN];
209 uint8_t orig[ETH_ALEN];
214 * batadv_icmp_packet - ICMP packet
215 * @icmph: common ICMP header
216 * @reserved: not used - useful for alignment
217 * @seqno: ICMP sequence number
219 struct batadv_icmp_packet {
220 struct batadv_icmp_header icmph;
225 #define BATADV_RR_LEN 16
228 * batadv_icmp_packet_rr - ICMP RouteRecord packet
229 * @icmph: common ICMP header
230 * @rr_cur: number of entries the rr array
231 * @seqno: ICMP sequence number
232 * @rr: route record array
234 struct batadv_icmp_packet_rr {
235 struct batadv_icmp_header icmph;
238 uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
241 #define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
243 /* All packet headers in front of an ethernet header have to be completely
244 * divisible by 2 but not by 4 to make the payload after the ethernet
245 * header again 4 bytes boundary aligned.
247 * A packing of 2 is necessary to avoid extra padding at the end of the struct
248 * caused by a structure member which is larger than two bytes. Otherwise
249 * the structure would not fulfill the previously mentioned rule to avoid the
250 * misalignment of the payload after the ethernet header. It may also lead to
251 * leakage of information when the padding it not initialized before sending.
256 * struct batadv_unicast_packet - unicast packet for network payload
257 * @packet_type: batman-adv packet type, part of the general header
258 * @version: batman-adv protocol version, part of the genereal header
259 * @ttl: time to live for this packet, part of the genereal header
260 * @ttvn: translation table version number
261 * @dest: originator destination of the unicast packet
263 struct batadv_unicast_packet {
267 uint8_t ttvn; /* destination translation table version number */
268 uint8_t dest[ETH_ALEN];
269 /* "4 bytes boundary + 2 bytes" long to make the payload after the
270 * following ethernet header again 4 bytes boundary aligned
275 * struct batadv_unicast_4addr_packet - extended unicast packet
276 * @u: common unicast packet header
277 * @src: address of the source
278 * @subtype: packet subtype
280 struct batadv_unicast_4addr_packet {
281 struct batadv_unicast_packet u;
282 uint8_t src[ETH_ALEN];
285 /* "4 bytes boundary + 2 bytes" long to make the payload after the
286 * following ethernet header again 4 bytes boundary aligned
291 * struct batadv_frag_packet - fragmented packet
292 * @packet_type: batman-adv packet type, part of the general header
293 * @version: batman-adv protocol version, part of the genereal header
294 * @ttl: time to live for this packet, part of the genereal header
295 * @dest: final destination used when routing fragments
296 * @orig: originator of the fragment used when merging the packet
297 * @no: fragment number within this sequence
298 * @reserved: reserved byte for alignment
299 * @seqno: sequence identification
300 * @total_size: size of the merged packet
302 struct batadv_frag_packet {
304 uint8_t version; /* batman version field */
306 #if defined(__BIG_ENDIAN_BITFIELD)
309 #elif defined(__LITTLE_ENDIAN_BITFIELD)
313 #error "unknown bitfield endianess"
315 uint8_t dest[ETH_ALEN];
316 uint8_t orig[ETH_ALEN];
322 * struct batadv_bcast_packet - broadcast packet for network payload
323 * @packet_type: batman-adv packet type, part of the general header
324 * @version: batman-adv protocol version, part of the genereal header
325 * @ttl: time to live for this packet, part of the genereal header
326 * @reserved: reserved byte for alignment
327 * @seqno: sequence identification
328 * @orig: originator of the broadcast packet
330 struct batadv_bcast_packet {
332 uint8_t version; /* batman version field */
336 uint8_t orig[ETH_ALEN];
337 /* "4 bytes boundary + 2 bytes" long to make the payload after the
338 * following ethernet header again 4 bytes boundary aligned
343 * struct batadv_coded_packet - network coded packet
344 * @packet_type: batman-adv packet type, part of the general header
345 * @version: batman-adv protocol version, part of the genereal header
346 * @ttl: time to live for this packet, part of the genereal header
347 * @reserved: Align following fields to 2-byte boundaries
348 * @first_source: original source of first included packet
349 * @first_orig_dest: original destinal of first included packet
350 * @first_crc: checksum of first included packet
351 * @first_ttvn: tt-version number of first included packet
352 * @second_ttl: ttl of second packet
353 * @second_dest: second receiver of this coded packet
354 * @second_source: original source of second included packet
355 * @second_orig_dest: original destination of second included packet
356 * @second_crc: checksum of second included packet
357 * @second_ttvn: tt version number of second included packet
358 * @coded_len: length of network coded part of the payload
360 struct batadv_coded_packet {
362 uint8_t version; /* batman version field */
365 /* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
366 uint8_t first_source[ETH_ALEN];
367 uint8_t first_orig_dest[ETH_ALEN];
371 uint8_t second_dest[ETH_ALEN];
372 uint8_t second_source[ETH_ALEN];
373 uint8_t second_orig_dest[ETH_ALEN];
381 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
382 * @packet_type: batman-adv packet type, part of the general header
383 * @version: batman-adv protocol version, part of the genereal header
384 * @ttl: time to live for this packet, part of the genereal header
385 * @reserved: reserved field (for packet alignment)
386 * @src: address of the source
387 * @dst: address of the destination
388 * @tvlv_len: length of tvlv data following the unicast tvlv header
389 * @align: 2 bytes to align the header to a 4 byte boundry
391 struct batadv_unicast_tvlv_packet {
393 uint8_t version; /* batman version field */
396 uint8_t dst[ETH_ALEN];
397 uint8_t src[ETH_ALEN];
403 * struct batadv_tvlv_hdr - base tvlv header struct
404 * @type: tvlv container type (see batadv_tvlv_type)
405 * @version: tvlv container version
406 * @len: tvlv container length
408 struct batadv_tvlv_hdr {
415 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
417 * @bandwidth_down: advertised uplink download bandwidth
418 * @bandwidth_up: advertised uplink upload bandwidth
420 struct batadv_tvlv_gateway_data {
421 __be32 bandwidth_down;
426 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
427 * @flags: translation table flags (see batadv_tt_data_flags)
428 * @ttvn: translation table version number
429 * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
430 * one batadv_tvlv_tt_vlan_data object per announced vlan
432 struct batadv_tvlv_tt_data {
439 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
440 * the tt tvlv container
441 * @crc: crc32 checksum of the entries belonging to this vlan
442 * @vid: vlan identifier
443 * @reserved: unused, useful for alignment purposes
445 struct batadv_tvlv_tt_vlan_data {
452 * struct batadv_tvlv_tt_change - translation table diff data
453 * @flags: status indicators concerning the non-mesh client (see
454 * batadv_tt_client_flags)
455 * @reserved: reserved field
456 * @addr: mac address of non-mesh client that triggered this tt change
457 * @vid: VLAN identifier
459 struct batadv_tvlv_tt_change {
462 uint8_t addr[ETH_ALEN];
467 * struct batadv_tvlv_roam_adv - roaming advertisement
468 * @client: mac address of roaming client
469 * @vid: VLAN identifier
471 struct batadv_tvlv_roam_adv {
472 uint8_t client[ETH_ALEN];
476 #endif /* _NET_BATMAN_ADV_PACKET_H_ */