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_vlan_flags - flags for the four MSB of any vlan ID field
133 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
135 enum batadv_vlan_flags {
136 BATADV_VLAN_HAS_TAG = BIT(15),
139 /* claim frame types for the bridge loop avoidance */
140 enum batadv_bla_claimframe {
141 BATADV_CLAIM_TYPE_CLAIM = 0x00,
142 BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
143 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02,
144 BATADV_CLAIM_TYPE_REQUEST = 0x03,
145 BATADV_CLAIM_TYPE_LOOPDETECT = 0x04,
149 * enum batadv_tvlv_type - tvlv type definitions
150 * @BATADV_TVLV_GW: gateway tvlv
151 * @BATADV_TVLV_DAT: distributed arp table tvlv
152 * @BATADV_TVLV_NC: network coding tvlv
153 * @BATADV_TVLV_TT: translation table tvlv
154 * @BATADV_TVLV_ROAM: roaming advertisement tvlv
155 * @BATADV_TVLV_MCAST: multicast capability tvlv
157 enum batadv_tvlv_type {
158 BATADV_TVLV_GW = 0x01,
159 BATADV_TVLV_DAT = 0x02,
160 BATADV_TVLV_NC = 0x03,
161 BATADV_TVLV_TT = 0x04,
162 BATADV_TVLV_ROAM = 0x05,
163 BATADV_TVLV_MCAST = 0x06,
167 /* the destination hardware field in the ARP frame is used to
168 * transport the claim type and the group id
170 struct batadv_bla_claim_dst {
171 u8 magic[3]; /* FF:43:05 */
172 u8 type; /* bla_claimframe */
173 __be16 group; /* group id */
179 * struct batadv_ogm_packet - ogm (routing protocol) packet
180 * @packet_type: batman-adv packet type, part of the general header
181 * @version: batman-adv protocol version, part of the genereal header
182 * @ttl: time to live for this packet, part of the genereal header
183 * @flags: contains routing relevant flags - see enum batadv_iv_flags
184 * @seqno: sequence identification
185 * @orig: address of the source node
186 * @prev_sender: address of the previous sender
187 * @reserved: reserved byte for alignment
188 * @tq: transmission quality
189 * @tvlv_len: length of tvlv data following the ogm header
191 struct batadv_ogm_packet {
198 u8 prev_sender[ETH_ALEN];
202 /* __packed is not needed as the struct size is divisible by 4,
203 * and the largest data type in this struct has a size of 4.
207 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
210 * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
211 * @packet_type: batman-adv packet type, part of the general header
212 * @version: batman-adv protocol version, part of the general header
213 * @ttl: time to live for this packet, part of the general header
214 * @flags: reseved for routing relevant flags - currently always 0
215 * @seqno: sequence number
216 * @orig: originator mac address
217 * @tvlv_len: length of the appended tvlv buffer (in bytes)
218 * @throughput: the currently flooded path throughput
220 struct batadv_ogm2_packet {
229 /* __packed is not needed as the struct size is divisible by 4,
230 * and the largest data type in this struct has a size of 4.
234 #define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
237 * struct batadv_elp_packet - elp (neighbor discovery) packet
238 * @packet_type: batman-adv packet type, part of the general header
239 * @version: batman-adv protocol version, part of the genereal header
240 * @orig: originator mac address
241 * @seqno: sequence number
242 * @elp_interval: currently used ELP sending interval in ms
244 struct batadv_elp_packet {
252 #define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
255 * enum batadv_icmp_user_cmd_type - types for batman-adv icmp cmd modes
256 * @BATADV_TP_START: start a throughput meter run
257 * @BATADV_TP_STOP: stop a throughput meter run
259 enum batadv_icmp_user_cmd_type {
265 * struct batadv_icmp_header - common members among all the ICMP packets
266 * @packet_type: batman-adv packet type, part of the general header
267 * @version: batman-adv protocol version, part of the genereal header
268 * @ttl: time to live for this packet, part of the genereal header
269 * @msg_type: ICMP packet type
270 * @dst: address of the destination node
271 * @orig: address of the source node
272 * @uid: local ICMP socket identifier
273 * @align: not used - useful for alignment purposes only
275 * This structure is used for ICMP packets parsing only and it is never sent
276 * over the wire. The alignment field at the end is there to ensure that
277 * members are padded the same way as they are in real packets.
279 struct batadv_icmp_header {
283 u8 msg_type; /* see ICMP message types above */
291 * struct batadv_icmp_packet - ICMP 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 * @msg_type: ICMP packet type
296 * @dst: address of the destination node
297 * @orig: address of the source node
298 * @uid: local ICMP socket identifier
299 * @reserved: not used - useful for alignment
300 * @seqno: ICMP sequence number
302 struct batadv_icmp_packet {
306 u8 msg_type; /* see ICMP message types above */
315 * struct batadv_icmp_tp_packet - ICMP TP Meter packet
316 * @packet_type: batman-adv packet type, part of the general header
317 * @version: batman-adv protocol version, part of the genereal header
318 * @ttl: time to live for this packet, part of the genereal header
319 * @msg_type: ICMP packet type
320 * @dst: address of the destination node
321 * @orig: address of the source node
322 * @uid: local ICMP socket identifier
323 * @subtype: TP packet subtype (see batadv_icmp_tp_subtype)
324 * @session: TP session identifier
325 * @seqno: the TP sequence number
326 * @timestamp: time when the packet has been sent. This value is filled in a
327 * TP_MSG and echoed back in the next TP_ACK so that the sender can compute the
328 * RTT. Since it is read only by the host which wrote it, there is no need to
329 * store it using network order
331 struct batadv_icmp_tp_packet {
335 u8 msg_type; /* see ICMP message types above */
346 * enum batadv_icmp_tp_subtype - ICMP TP Meter packet subtypes
347 * @BATADV_TP_MSG: Msg from sender to receiver
348 * @BATADV_TP_ACK: acknowledgment from receiver to sender
350 enum batadv_icmp_tp_subtype {
355 #define BATADV_RR_LEN 16
358 * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
359 * @packet_type: batman-adv packet type, part of the general header
360 * @version: batman-adv protocol version, part of the genereal header
361 * @ttl: time to live for this packet, part of the genereal header
362 * @msg_type: ICMP packet type
363 * @dst: address of the destination node
364 * @orig: address of the source node
365 * @uid: local ICMP socket identifier
366 * @rr_cur: number of entries the rr array
367 * @seqno: ICMP sequence number
368 * @rr: route record array
370 struct batadv_icmp_packet_rr {
374 u8 msg_type; /* see ICMP message types above */
380 u8 rr[BATADV_RR_LEN][ETH_ALEN];
383 #define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr)
385 /* All packet headers in front of an ethernet header have to be completely
386 * divisible by 2 but not by 4 to make the payload after the ethernet
387 * header again 4 bytes boundary aligned.
389 * A packing of 2 is necessary to avoid extra padding at the end of the struct
390 * caused by a structure member which is larger than two bytes. Otherwise
391 * the structure would not fulfill the previously mentioned rule to avoid the
392 * misalignment of the payload after the ethernet header. It may also lead to
393 * leakage of information when the padding it not initialized before sending.
398 * struct batadv_unicast_packet - unicast packet for network payload
399 * @packet_type: batman-adv packet type, part of the general header
400 * @version: batman-adv protocol version, part of the genereal header
401 * @ttl: time to live for this packet, part of the genereal header
402 * @ttvn: translation table version number
403 * @dest: originator destination of the unicast packet
405 struct batadv_unicast_packet {
409 u8 ttvn; /* destination translation table version number */
411 /* "4 bytes boundary + 2 bytes" long to make the payload after the
412 * following ethernet header again 4 bytes boundary aligned
417 * struct batadv_unicast_4addr_packet - extended unicast packet
418 * @u: common unicast packet header
419 * @src: address of the source
420 * @subtype: packet subtype
421 * @reserved: reserved byte for alignment
423 struct batadv_unicast_4addr_packet {
424 struct batadv_unicast_packet u;
428 /* "4 bytes boundary + 2 bytes" long to make the payload after the
429 * following ethernet header again 4 bytes boundary aligned
434 * struct batadv_frag_packet - fragmented packet
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 * @dest: final destination used when routing fragments
439 * @orig: originator of the fragment used when merging the packet
440 * @no: fragment number within this sequence
441 * @priority: priority of frame, from ToS IP precedence or 802.1p
442 * @reserved: reserved byte for alignment
443 * @seqno: sequence identification
444 * @total_size: size of the merged packet
446 struct batadv_frag_packet {
448 u8 version; /* batman version field */
450 #if defined(__BIG_ENDIAN_BITFIELD)
454 #elif defined(__LITTLE_ENDIAN_BITFIELD)
459 #error "unknown bitfield endianness"
468 * struct batadv_bcast_packet - broadcast packet for network payload
469 * @packet_type: batman-adv packet type, part of the general header
470 * @version: batman-adv protocol version, part of the genereal header
471 * @ttl: time to live for this packet, part of the genereal header
472 * @reserved: reserved byte for alignment
473 * @seqno: sequence identification
474 * @orig: originator of the broadcast packet
476 struct batadv_bcast_packet {
478 u8 version; /* batman version field */
483 /* "4 bytes boundary + 2 bytes" long to make the payload after the
484 * following ethernet header again 4 bytes boundary aligned
489 * struct batadv_coded_packet - network coded packet
490 * @packet_type: batman-adv packet type, part of the general header
491 * @version: batman-adv protocol version, part of the genereal header
492 * @ttl: time to live for this packet, part of the genereal header
493 * @first_source: original source of first included packet
494 * @first_orig_dest: original destinal of first included packet
495 * @first_crc: checksum of first included packet
496 * @first_ttvn: tt-version number of first included packet
497 * @second_ttl: ttl of second packet
498 * @second_dest: second receiver of this coded packet
499 * @second_source: original source of second included packet
500 * @second_orig_dest: original destination of second included packet
501 * @second_crc: checksum of second included packet
502 * @second_ttvn: tt version number of second included packet
503 * @coded_len: length of network coded part of the payload
505 struct batadv_coded_packet {
507 u8 version; /* batman version field */
510 /* u8 first_dest[ETH_ALEN]; - saved in mac header destination */
511 u8 first_source[ETH_ALEN];
512 u8 first_orig_dest[ETH_ALEN];
516 u8 second_dest[ETH_ALEN];
517 u8 second_source[ETH_ALEN];
518 u8 second_orig_dest[ETH_ALEN];
526 * struct batadv_unicast_tvlv_packet - generic unicast packet with tvlv payload
527 * @packet_type: batman-adv packet type, part of the general header
528 * @version: batman-adv protocol version, part of the genereal header
529 * @ttl: time to live for this packet, part of the genereal header
530 * @reserved: reserved field (for packet alignment)
531 * @src: address of the source
532 * @dst: address of the destination
533 * @tvlv_len: length of tvlv data following the unicast tvlv header
534 * @align: 2 bytes to align the header to a 4 byte boundary
536 struct batadv_unicast_tvlv_packet {
538 u8 version; /* batman version field */
548 * struct batadv_tvlv_hdr - base tvlv header struct
549 * @type: tvlv container type (see batadv_tvlv_type)
550 * @version: tvlv container version
551 * @len: tvlv container length
553 struct batadv_tvlv_hdr {
560 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
562 * @bandwidth_down: advertised uplink download bandwidth
563 * @bandwidth_up: advertised uplink upload bandwidth
565 struct batadv_tvlv_gateway_data {
566 __be32 bandwidth_down;
571 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
572 * @flags: translation table flags (see batadv_tt_data_flags)
573 * @ttvn: translation table version number
574 * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
575 * one batadv_tvlv_tt_vlan_data object per announced vlan
577 struct batadv_tvlv_tt_data {
584 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
585 * the tt tvlv container
586 * @crc: crc32 checksum of the entries belonging to this vlan
587 * @vid: vlan identifier
588 * @reserved: unused, useful for alignment purposes
590 struct batadv_tvlv_tt_vlan_data {
597 * struct batadv_tvlv_tt_change - translation table diff data
598 * @flags: status indicators concerning the non-mesh client (see
599 * batadv_tt_client_flags)
600 * @reserved: reserved field - useful for alignment purposes only
601 * @addr: mac address of non-mesh client that triggered this tt change
602 * @vid: VLAN identifier
604 struct batadv_tvlv_tt_change {
612 * struct batadv_tvlv_roam_adv - roaming advertisement
613 * @client: mac address of roaming client
614 * @vid: VLAN identifier
616 struct batadv_tvlv_roam_adv {
622 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
623 * @flags: multicast flags announced by the orig node
624 * @reserved: reserved field
626 struct batadv_tvlv_mcast_data {
631 #endif /* _NET_BATMAN_ADV_PACKET_H_ */