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
115 enum batadv_tt_client_flags {
116 BATADV_TT_CLIENT_DEL = BIT(0),
117 BATADV_TT_CLIENT_ROAM = BIT(1),
118 BATADV_TT_CLIENT_WIFI = BIT(2),
119 BATADV_TT_CLIENT_NOPURGE = BIT(8),
120 BATADV_TT_CLIENT_NEW = BIT(9),
121 BATADV_TT_CLIENT_PENDING = BIT(10),
122 BATADV_TT_CLIENT_TEMP = BIT(11),
125 /* claim frame types for the bridge loop avoidance */
126 enum batadv_bla_claimframe {
127 BATADV_CLAIM_TYPE_CLAIM = 0x00,
128 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
129 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
130 BATADV_CLAIM_TYPE_REQUEST = 0x03,
134 * enum batadv_tvlv_type - tvlv type definitions
135 * @BATADV_TVLV_GW: gateway tvlv
136 * @BATADV_TVLV_DAT: distributed arp table tvlv
137 * @BATADV_TVLV_NC: network coding tvlv
138 * @BATADV_TVLV_TT: translation table tvlv
139 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
141 enum batadv_tvlv_type {
142 BATADV_TVLV_GW = 0x01,
143 BATADV_TVLV_DAT = 0x02,
144 BATADV_TVLV_NC = 0x03,
145 BATADV_TVLV_TT = 0x04,
146 BATADV_TVLV_ROAM = 0x05,
149 /* the destination hardware field in the ARP frame is used to
150 * transport the claim type and the group id
152 struct batadv_bla_claim_dst {
153 uint8_t magic[3]; /* FF:43:05 */
154 uint8_t type; /* bla_claimframe */
155 __be16 group; /* group id */
158 struct batadv_header {
160 uint8_t version; /* batman version field */
162 /* the parent struct has to add a byte after the header to make
163 * everything 4 bytes aligned again
168 * struct batadv_ogm_packet - ogm (routing protocol) packet
169 * @header: common batman packet header
170 * @flags: contains routing relevant flags - see enum batadv_iv_flags
171 * @tvlv_len: length of tvlv data following the ogm header
173 struct batadv_ogm_packet {
174 struct batadv_header header;
177 uint8_t orig[ETH_ALEN];
178 uint8_t prev_sender[ETH_ALEN];
182 /* __packed is not needed as the struct size is divisible by 4,
183 * and the largest data type in this struct has a size of 4.
187 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
190 * batadv_icmp_header - common ICMP header
191 * @header: common batman header
192 * @msg_type: ICMP packet type
193 * @dst: address of the destination node
194 * @orig: address of the source node
195 * @uid: local ICMP socket identifier
197 struct batadv_icmp_header {
198 struct batadv_header header;
199 uint8_t msg_type; /* see ICMP message types above */
200 uint8_t dst[ETH_ALEN];
201 uint8_t orig[ETH_ALEN];
206 * batadv_icmp_packet - ICMP packet
207 * @icmph: common ICMP header
208 * @reserved: not used - useful for alignment
209 * @seqno: ICMP sequence number
211 struct batadv_icmp_packet {
212 struct batadv_icmp_header icmph;
217 #define BATADV_RR_LEN 16
220 * batadv_icmp_packet_rr - ICMP RouteRecord packet
221 * @icmph: common ICMP header
222 * @rr_cur: number of entries the rr array
223 * @seqno: ICMP sequence number
224 * @rr: route record array
226 struct batadv_icmp_packet_rr {
227 struct batadv_icmp_header icmph;
230 uint8_t rr[BATADV_RR_LEN][ETH_ALEN];
233 /* All packet headers in front of an ethernet header have to be completely
234 * divisible by 2 but not by 4 to make the payload after the ethernet
235 * header again 4 bytes boundary aligned.
237 * A packing of 2 is necessary to avoid extra padding at the end of the struct
238 * caused by a structure member which is larger than two bytes. Otherwise
239 * the structure would not fulfill the previously mentioned rule to avoid the
240 * misalignment of the payload after the ethernet header. It may also lead to
241 * leakage of information when the padding it not initialized before sending.
245 struct batadv_unicast_packet {
246 struct batadv_header header;
247 uint8_t ttvn; /* destination translation table version number */
248 uint8_t dest[ETH_ALEN];
249 /* "4 bytes boundary + 2 bytes" long to make the payload after the
250 * following ethernet header again 4 bytes boundary aligned
255 * struct batadv_unicast_4addr_packet - extended unicast packet
256 * @u: common unicast packet header
257 * @src: address of the source
258 * @subtype: packet subtype
260 struct batadv_unicast_4addr_packet {
261 struct batadv_unicast_packet u;
262 uint8_t src[ETH_ALEN];
265 /* "4 bytes boundary + 2 bytes" long to make the payload after the
266 * following ethernet header again 4 bytes boundary aligned
271 * struct batadv_frag_packet - fragmented packet
272 * @header: common batman packet header with type, compatversion, and ttl
273 * @dest: final destination used when routing fragments
274 * @orig: originator of the fragment used when merging the packet
275 * @no: fragment number within this sequence
276 * @reserved: reserved byte for alignment
277 * @seqno: sequence identification
278 * @total_size: size of the merged packet
280 struct batadv_frag_packet {
281 struct batadv_header header;
282 #if defined(__BIG_ENDIAN_BITFIELD)
285 #elif defined(__LITTLE_ENDIAN_BITFIELD)
289 #error "unknown bitfield endianess"
291 uint8_t dest[ETH_ALEN];
292 uint8_t orig[ETH_ALEN];
297 struct batadv_bcast_packet {
298 struct batadv_header header;
301 uint8_t orig[ETH_ALEN];
302 /* "4 bytes boundary + 2 bytes" long to make the payload after the
303 * following ethernet header again 4 bytes boundary aligned
310 * struct batadv_coded_packet - network coded packet
311 * @header: common batman packet header and ttl of first included packet
312 * @reserved: Align following fields to 2-byte boundaries
313 * @first_source: original source of first included packet
314 * @first_orig_dest: original destinal of first included packet
315 * @first_crc: checksum of first included packet
316 * @first_ttvn: tt-version number of first included packet
317 * @second_ttl: ttl of second packet
318 * @second_dest: second receiver of this coded packet
319 * @second_source: original source of second included packet
320 * @second_orig_dest: original destination of second included packet
321 * @second_crc: checksum of second included packet
322 * @second_ttvn: tt version number of second included packet
323 * @coded_len: length of network coded part of the payload
325 struct batadv_coded_packet {
326 struct batadv_header header;
328 /* uint8_t first_dest[ETH_ALEN]; - saved in mac header destination */
329 uint8_t first_source[ETH_ALEN];
330 uint8_t first_orig_dest[ETH_ALEN];
334 uint8_t second_dest[ETH_ALEN];
335 uint8_t second_source[ETH_ALEN];
336 uint8_t second_orig_dest[ETH_ALEN];
342 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
343 * @header: common batman packet header
344 * @reserved: reserved field (for packet alignment)
345 * @src: address of the source
346 * @dst: address of the destination
347 * @tvlv_len: length of tvlv data following the unicast tvlv header
348 * @align: 2 bytes to align the header to a 4 byte boundry
350 struct batadv_unicast_tvlv_packet {
351 struct batadv_header header;
353 uint8_t dst[ETH_ALEN];
354 uint8_t src[ETH_ALEN];
360 * struct batadv_tvlv_hdr - base tvlv header struct
361 * @type: tvlv container type (see batadv_tvlv_type)
362 * @version: tvlv container version
363 * @len: tvlv container length
365 struct batadv_tvlv_hdr {
372 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
374 * @bandwidth_down: advertised uplink download bandwidth
375 * @bandwidth_up: advertised uplink upload bandwidth
377 struct batadv_tvlv_gateway_data {
378 __be32 bandwidth_down;
383 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
384 * @flags: translation table flags (see batadv_tt_data_flags)
385 * @ttvn: translation table version number
386 * @reserved: field reserved for future use
387 * @crc: crc32 checksum of the local translation table
389 struct batadv_tvlv_tt_data {
397 * struct batadv_tvlv_tt_change - translation table diff data
398 * @flags: status indicators concerning the non-mesh client (see
399 * batadv_tt_client_flags)
400 * @reserved: reserved field
401 * @addr: mac address of non-mesh client that triggered this tt change
403 struct batadv_tvlv_tt_change {
406 uint8_t addr[ETH_ALEN];
410 * struct batadv_tvlv_roam_adv - roaming advertisement
411 * @client: mac address of roaming client
412 * @reserved: field reserved for future use
414 struct batadv_tvlv_roam_adv {
415 uint8_t client[ETH_ALEN];
419 #endif /* _NET_BATMAN_ADV_PACKET_H_ */