1 /* Copyright (C) 2007-2016 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, see <http://www.gnu.org/licenses/>.
18 #ifndef _NET_BATMAN_ADV_PACKET_H_
19 #define _NET_BATMAN_ADV_PACKET_H_
21 #include <asm/byteorder.h>
22 #include <linux/types.h>
24 #define batadv_tp_is_error(n) ((u8)n > 127 ? 1 : 0)
27 * enum batadv_packettype - types for batman-adv encapsulated packets
28 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
29 * @BATADV_BCAST: broadcast packets carrying broadcast payload
30 * @BATADV_CODED: network coded packets
31 * @BATADV_ELP: echo location packets for B.A.T.M.A.N. V
32 * @BATADV_OGM2: originator messages for B.A.T.M.A.N. V
34 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
35 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
37 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
39 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
40 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
42 enum batadv_packettype
{
43 /* 0x00 - 0x3f: local packets or special rules for handling */
49 /* 0x40 - 0x7f: unicast */
50 #define BATADV_UNICAST_MIN 0x40
51 BATADV_UNICAST
= 0x40,
52 BATADV_UNICAST_FRAG
= 0x41,
53 BATADV_UNICAST_4ADDR
= 0x42,
55 BATADV_UNICAST_TVLV
= 0x44,
56 #define BATADV_UNICAST_MAX 0x7f
57 /* 0x80 - 0xff: reserved */
61 * enum batadv_subtype - packet subtype for unicast4addr
62 * @BATADV_P_DATA: user payload
63 * @BATADV_P_DAT_DHT_GET: DHT request message
64 * @BATADV_P_DAT_DHT_PUT: DHT store message
65 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
69 BATADV_P_DAT_DHT_GET
= 0x02,
70 BATADV_P_DAT_DHT_PUT
= 0x03,
71 BATADV_P_DAT_CACHE_REPLY
= 0x04,
74 /* this file is included by batctl which needs these defines */
75 #define BATADV_COMPAT_VERSION 15
78 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
79 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
80 * previously received from someone else than the best neighbor.
81 * @BATADV_PRIMARIES_FIRST_HOP: flag unused.
82 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
83 * one hop neighbor on the interface where it was originally received.
85 enum batadv_iv_flags
{
86 BATADV_NOT_BEST_NEXT_HOP
= BIT(0),
87 BATADV_PRIMARIES_FIRST_HOP
= BIT(1),
88 BATADV_DIRECTLINK
= BIT(2),
91 /* ICMP message types */
92 enum batadv_icmp_packettype
{
93 BATADV_ECHO_REPLY
= 0,
94 BATADV_DESTINATION_UNREACHABLE
= 3,
95 BATADV_ECHO_REQUEST
= 8,
96 BATADV_TTL_EXCEEDED
= 11,
97 BATADV_PARAMETER_PROBLEM
= 12,
102 * enum batadv_mcast_flags - flags for multicast capabilities and settings
103 * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for
104 * 224.0.0.0/24 or ff02::1
105 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets
106 * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets
108 enum batadv_mcast_flags
{
109 BATADV_MCAST_WANT_ALL_UNSNOOPABLES
= BIT(0),
110 BATADV_MCAST_WANT_ALL_IPV4
= BIT(1),
111 BATADV_MCAST_WANT_ALL_IPV6
= BIT(2),
114 /* tt data subtypes */
115 #define BATADV_TT_DATA_TYPE_MASK 0x0F
118 * enum batadv_tt_data_flags - flags for tt data tvlv
119 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
120 * @BATADV_TT_REQUEST: TT request message
121 * @BATADV_TT_RESPONSE: TT response message
122 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
124 enum batadv_tt_data_flags
{
125 BATADV_TT_OGM_DIFF
= BIT(0),
126 BATADV_TT_REQUEST
= BIT(1),
127 BATADV_TT_RESPONSE
= BIT(2),
128 BATADV_TT_FULL_TABLE
= BIT(4),
132 * enum batadv_tt_client_flags - TT client specific flags
133 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
134 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
135 * update telling its new real location has not been received/sent yet
136 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
137 * This information is used by the "AP Isolation" feature
138 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
139 * information is used by the Extended Isolation feature
140 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
141 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
142 * not been announced yet
143 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
144 * in the table for one more originator interval for consistency purposes
145 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
146 * the network but no nnode has already announced it
148 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
149 * Bits from 8 to 15 are called _local flags_ because they are used for local
152 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
153 * the other nodes in the network. To achieve this goal these flags are included
154 * in the TT CRC computation.
156 enum batadv_tt_client_flags
{
157 BATADV_TT_CLIENT_DEL
= BIT(0),
158 BATADV_TT_CLIENT_ROAM
= BIT(1),
159 BATADV_TT_CLIENT_WIFI
= BIT(4),
160 BATADV_TT_CLIENT_ISOLA
= BIT(5),
161 BATADV_TT_CLIENT_NOPURGE
= BIT(8),
162 BATADV_TT_CLIENT_NEW
= BIT(9),
163 BATADV_TT_CLIENT_PENDING
= BIT(10),
164 BATADV_TT_CLIENT_TEMP
= BIT(11),
168 * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field
169 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
171 enum batadv_vlan_flags
{
172 BATADV_VLAN_HAS_TAG
= BIT(15),
175 /* claim frame types for the bridge loop avoidance */
176 enum batadv_bla_claimframe
{
177 BATADV_CLAIM_TYPE_CLAIM
= 0x00,
178 BATADV_CLAIM_TYPE_UNCLAIM
= 0x01,
179 BATADV_CLAIM_TYPE_ANNOUNCE
= 0x02,
180 BATADV_CLAIM_TYPE_REQUEST
= 0x03,
181 BATADV_CLAIM_TYPE_LOOPDETECT
= 0x04,
185 * enum batadv_tvlv_type - tvlv type definitions
186 * @BATADV_TVLV_GW: gateway tvlv
187 * @BATADV_TVLV_DAT: distributed arp table tvlv
188 * @BATADV_TVLV_NC: network coding tvlv
189 * @BATADV_TVLV_TT: translation table tvlv
190 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
191 * @BATADV_TVLV_MCAST: multicast capability tvlv
193 enum batadv_tvlv_type
{
194 BATADV_TVLV_GW
= 0x01,
195 BATADV_TVLV_DAT
= 0x02,
196 BATADV_TVLV_NC
= 0x03,
197 BATADV_TVLV_TT
= 0x04,
198 BATADV_TVLV_ROAM
= 0x05,
199 BATADV_TVLV_MCAST
= 0x06,
203 /* the destination hardware field in the ARP frame is used to
204 * transport the claim type and the group id
206 struct batadv_bla_claim_dst
{
207 u8 magic
[3]; /* FF:43:05 */
208 u8 type
; /* bla_claimframe */
209 __be16 group
; /* group id */
215 * struct batadv_ogm_packet - ogm (routing protocol) packet
216 * @packet_type: batman-adv packet type, part of the general header
217 * @version: batman-adv protocol version, part of the genereal header
218 * @ttl: time to live for this packet, part of the genereal header
219 * @flags: contains routing relevant flags - see enum batadv_iv_flags
220 * @seqno: sequence identification
221 * @orig: address of the source node
222 * @prev_sender: address of the previous sender
223 * @reserved: reserved byte for alignment
224 * @tq: transmission quality
225 * @tvlv_len: length of tvlv data following the ogm header
227 struct batadv_ogm_packet
{
234 u8 prev_sender
[ETH_ALEN
];
238 /* __packed is not needed as the struct size is divisible by 4,
239 * and the largest data type in this struct has a size of 4.
243 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
246 * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
247 * @packet_type: batman-adv packet type, part of the general header
248 * @version: batman-adv protocol version, part of the general header
249 * @ttl: time to live for this packet, part of the general header
250 * @flags: reseved for routing relevant flags - currently always 0
251 * @seqno: sequence number
252 * @orig: originator mac address
253 * @tvlv_len: length of the appended tvlv buffer (in bytes)
254 * @throughput: the currently flooded path throughput
256 struct batadv_ogm2_packet
{
265 /* __packed is not needed as the struct size is divisible by 4,
266 * and the largest data type in this struct has a size of 4.
270 #define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
273 * struct batadv_elp_packet - elp (neighbor discovery) packet
274 * @packet_type: batman-adv packet type, part of the general header
275 * @version: batman-adv protocol version, part of the genereal header
276 * @orig: originator mac address
277 * @seqno: sequence number
278 * @elp_interval: currently used ELP sending interval in ms
280 struct batadv_elp_packet
{
288 #define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
291 * enum batadv_icmp_user_cmd_type - types for batman-adv icmp cmd modes
292 * @BATADV_TP_START: start a throughput meter run
293 * @BATADV_TP_STOP: stop a throughput meter run
295 enum batadv_icmp_user_cmd_type
{
301 * struct batadv_icmp_header - common members among all the ICMP packets
302 * @packet_type: batman-adv packet type, part of the general header
303 * @version: batman-adv protocol version, part of the genereal header
304 * @ttl: time to live for this packet, part of the genereal header
305 * @msg_type: ICMP packet type
306 * @dst: address of the destination node
307 * @orig: address of the source node
308 * @uid: local ICMP socket identifier
309 * @align: not used - useful for alignment purposes only
311 * This structure is used for ICMP packets parsing only and it is never sent
312 * over the wire. The alignment field at the end is there to ensure that
313 * members are padded the same way as they are in real packets.
315 struct batadv_icmp_header
{
319 u8 msg_type
; /* see ICMP message types above */
327 * struct batadv_icmp_packet - ICMP packet
328 * @packet_type: batman-adv packet type, part of the general header
329 * @version: batman-adv protocol version, part of the genereal header
330 * @ttl: time to live for this packet, part of the genereal header
331 * @msg_type: ICMP packet type
332 * @dst: address of the destination node
333 * @orig: address of the source node
334 * @uid: local ICMP socket identifier
335 * @reserved: not used - useful for alignment
336 * @seqno: ICMP sequence number
338 struct batadv_icmp_packet
{
342 u8 msg_type
; /* see ICMP message types above */
351 * struct batadv_icmp_tp_packet - ICMP TP Meter packet
352 * @packet_type: batman-adv packet type, part of the general header
353 * @version: batman-adv protocol version, part of the genereal header
354 * @ttl: time to live for this packet, part of the genereal header
355 * @msg_type: ICMP packet type
356 * @dst: address of the destination node
357 * @orig: address of the source node
358 * @uid: local ICMP socket identifier
359 * @subtype: TP packet subtype (see batadv_icmp_tp_subtype)
360 * @session: TP session identifier
361 * @seqno: the TP sequence number
362 * @timestamp: time when the packet has been sent. This value is filled in a
363 * TP_MSG and echoed back in the next TP_ACK so that the sender can compute the
364 * RTT. Since it is read only by the host which wrote it, there is no need to
365 * store it using network order
367 struct batadv_icmp_tp_packet
{
371 u8 msg_type
; /* see ICMP message types above */
382 * enum batadv_icmp_tp_subtype - ICMP TP Meter packet subtypes
383 * @BATADV_TP_MSG: Msg from sender to receiver
384 * @BATADV_TP_ACK: acknowledgment from receiver to sender
386 enum batadv_icmp_tp_subtype
{
391 #define BATADV_RR_LEN 16
394 * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
395 * @packet_type: batman-adv packet type, part of the general header
396 * @version: batman-adv protocol version, part of the genereal header
397 * @ttl: time to live for this packet, part of the genereal header
398 * @msg_type: ICMP packet type
399 * @dst: address of the destination node
400 * @orig: address of the source node
401 * @uid: local ICMP socket identifier
402 * @rr_cur: number of entries the rr array
403 * @seqno: ICMP sequence number
404 * @rr: route record array
406 struct batadv_icmp_packet_rr
{
410 u8 msg_type
; /* see ICMP message types above */
416 u8 rr
[BATADV_RR_LEN
][ETH_ALEN
];
419 #define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
421 /* All packet headers in front of an ethernet header have to be completely
422 * divisible by 2 but not by 4 to make the payload after the ethernet
423 * header again 4 bytes boundary aligned.
425 * A packing of 2 is necessary to avoid extra padding at the end of the struct
426 * caused by a structure member which is larger than two bytes. Otherwise
427 * the structure would not fulfill the previously mentioned rule to avoid the
428 * misalignment of the payload after the ethernet header. It may also lead to
429 * leakage of information when the padding it not initialized before sending.
434 * struct batadv_unicast_packet - unicast packet for network payload
435 * @packet_type: batman-adv packet type, part of the general header
436 * @version: batman-adv protocol version, part of the genereal header
437 * @ttl: time to live for this packet, part of the genereal header
438 * @ttvn: translation table version number
439 * @dest: originator destination of the unicast packet
441 struct batadv_unicast_packet
{
445 u8 ttvn
; /* destination translation table version number */
447 /* "4 bytes boundary + 2 bytes" long to make the payload after the
448 * following ethernet header again 4 bytes boundary aligned
453 * struct batadv_unicast_4addr_packet - extended unicast packet
454 * @u: common unicast packet header
455 * @src: address of the source
456 * @subtype: packet subtype
457 * @reserved: reserved byte for alignment
459 struct batadv_unicast_4addr_packet
{
460 struct batadv_unicast_packet u
;
464 /* "4 bytes boundary + 2 bytes" long to make the payload after the
465 * following ethernet header again 4 bytes boundary aligned
470 * struct batadv_frag_packet - fragmented packet
471 * @packet_type: batman-adv packet type, part of the general header
472 * @version: batman-adv protocol version, part of the genereal header
473 * @ttl: time to live for this packet, part of the genereal header
474 * @dest: final destination used when routing fragments
475 * @orig: originator of the fragment used when merging the packet
476 * @no: fragment number within this sequence
477 * @priority: priority of frame, from ToS IP precedence or 802.1p
478 * @reserved: reserved byte for alignment
479 * @seqno: sequence identification
480 * @total_size: size of the merged packet
482 struct batadv_frag_packet
{
484 u8 version
; /* batman version field */
486 #if defined(__BIG_ENDIAN_BITFIELD)
490 #elif defined(__LITTLE_ENDIAN_BITFIELD)
495 #error "unknown bitfield endianness"
504 * struct batadv_bcast_packet - broadcast packet for network payload
505 * @packet_type: batman-adv packet type, part of the general header
506 * @version: batman-adv protocol version, part of the genereal header
507 * @ttl: time to live for this packet, part of the genereal header
508 * @reserved: reserved byte for alignment
509 * @seqno: sequence identification
510 * @orig: originator of the broadcast packet
512 struct batadv_bcast_packet
{
514 u8 version
; /* batman version field */
519 /* "4 bytes boundary + 2 bytes" long to make the payload after the
520 * following ethernet header again 4 bytes boundary aligned
525 * struct batadv_coded_packet - network coded packet
526 * @packet_type: batman-adv packet type, part of the general header
527 * @version: batman-adv protocol version, part of the genereal header
528 * @ttl: time to live for this packet, part of the genereal header
529 * @first_source: original source of first included packet
530 * @first_orig_dest: original destinal of first included packet
531 * @first_crc: checksum of first included packet
532 * @first_ttvn: tt-version number of first included packet
533 * @second_ttl: ttl of second packet
534 * @second_dest: second receiver of this coded packet
535 * @second_source: original source of second included packet
536 * @second_orig_dest: original destination of second included packet
537 * @second_crc: checksum of second included packet
538 * @second_ttvn: tt version number of second included packet
539 * @coded_len: length of network coded part of the payload
541 struct batadv_coded_packet
{
543 u8 version
; /* batman version field */
546 /* u8 first_dest[ETH_ALEN]; - saved in mac header destination */
547 u8 first_source
[ETH_ALEN
];
548 u8 first_orig_dest
[ETH_ALEN
];
552 u8 second_dest
[ETH_ALEN
];
553 u8 second_source
[ETH_ALEN
];
554 u8 second_orig_dest
[ETH_ALEN
];
562 * struct batadv_unicast_tvlv_packet - generic unicast packet with tvlv payload
563 * @packet_type: batman-adv packet type, part of the general header
564 * @version: batman-adv protocol version, part of the genereal header
565 * @ttl: time to live for this packet, part of the genereal header
566 * @reserved: reserved field (for packet alignment)
567 * @src: address of the source
568 * @dst: address of the destination
569 * @tvlv_len: length of tvlv data following the unicast tvlv header
570 * @align: 2 bytes to align the header to a 4 byte boundary
572 struct batadv_unicast_tvlv_packet
{
574 u8 version
; /* batman version field */
584 * struct batadv_tvlv_hdr - base tvlv header struct
585 * @type: tvlv container type (see batadv_tvlv_type)
586 * @version: tvlv container version
587 * @len: tvlv container length
589 struct batadv_tvlv_hdr
{
596 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
598 * @bandwidth_down: advertised uplink download bandwidth
599 * @bandwidth_up: advertised uplink upload bandwidth
601 struct batadv_tvlv_gateway_data
{
602 __be32 bandwidth_down
;
607 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
608 * @flags: translation table flags (see batadv_tt_data_flags)
609 * @ttvn: translation table version number
610 * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
611 * one batadv_tvlv_tt_vlan_data object per announced vlan
613 struct batadv_tvlv_tt_data
{
620 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
621 * the tt tvlv container
622 * @crc: crc32 checksum of the entries belonging to this vlan
623 * @vid: vlan identifier
624 * @reserved: unused, useful for alignment purposes
626 struct batadv_tvlv_tt_vlan_data
{
633 * struct batadv_tvlv_tt_change - translation table diff data
634 * @flags: status indicators concerning the non-mesh client (see
635 * batadv_tt_client_flags)
636 * @reserved: reserved field - useful for alignment purposes only
637 * @addr: mac address of non-mesh client that triggered this tt change
638 * @vid: VLAN identifier
640 struct batadv_tvlv_tt_change
{
648 * struct batadv_tvlv_roam_adv - roaming advertisement
649 * @client: mac address of roaming client
650 * @vid: VLAN identifier
652 struct batadv_tvlv_roam_adv
{
658 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
659 * @flags: multicast flags announced by the orig node
660 * @reserved: reserved field
662 struct batadv_tvlv_mcast_data
{
667 #endif /* _NET_BATMAN_ADV_PACKET_H_ */