Merge tag 'omap-for-v4.7/fixes-v2' of git://git.kernel.org/pub/scm/linux/kernel/git...
[cascardo/linux.git] / net / batman-adv / packet.h
1 /* Copyright (C) 2007-2016  B.A.T.M.A.N. contributors:
2  *
3  * Marek Lindner, Simon Wunderlich
4  *
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.
8  *
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.
13  *
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/>.
16  */
17
18 #ifndef _NET_BATMAN_ADV_PACKET_H_
19 #define _NET_BATMAN_ADV_PACKET_H_
20
21 #include <asm/byteorder.h>
22 #include <linux/types.h>
23
24 /**
25  * enum batadv_packettype - types for batman-adv encapsulated packets
26  * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
27  * @BATADV_BCAST: broadcast packets carrying broadcast payload
28  * @BATADV_CODED: network coded packets
29  * @BATADV_ELP: echo location packets for B.A.T.M.A.N. V
30  * @BATADV_OGM2: originator messages for B.A.T.M.A.N. V
31  *
32  * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
33  * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
34  *     payload packet
35  * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
36  *     the sender
37  * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
38  * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
39  */
40 enum batadv_packettype {
41         /* 0x00 - 0x3f: local packets or special rules for handling */
42         BATADV_IV_OGM           = 0x00,
43         BATADV_BCAST            = 0x01,
44         BATADV_CODED            = 0x02,
45         BATADV_ELP              = 0x03,
46         BATADV_OGM2             = 0x04,
47         /* 0x40 - 0x7f: unicast */
48 #define BATADV_UNICAST_MIN     0x40
49         BATADV_UNICAST          = 0x40,
50         BATADV_UNICAST_FRAG     = 0x41,
51         BATADV_UNICAST_4ADDR    = 0x42,
52         BATADV_ICMP             = 0x43,
53         BATADV_UNICAST_TVLV     = 0x44,
54 #define BATADV_UNICAST_MAX     0x7f
55         /* 0x80 - 0xff: reserved */
56 };
57
58 /**
59  * enum batadv_subtype - packet subtype for unicast4addr
60  * @BATADV_P_DATA: user payload
61  * @BATADV_P_DAT_DHT_GET: DHT request message
62  * @BATADV_P_DAT_DHT_PUT: DHT store message
63  * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
64  */
65 enum batadv_subtype {
66         BATADV_P_DATA                   = 0x01,
67         BATADV_P_DAT_DHT_GET            = 0x02,
68         BATADV_P_DAT_DHT_PUT            = 0x03,
69         BATADV_P_DAT_CACHE_REPLY        = 0x04,
70 };
71
72 /* this file is included by batctl which needs these defines */
73 #define BATADV_COMPAT_VERSION 15
74
75 /**
76  * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
77  * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
78  *     previously received from someone else than the best neighbor.
79  * @BATADV_PRIMARIES_FIRST_HOP: flag unused.
80  * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a
81  *     one hop neighbor on the interface where it was originally received.
82  */
83 enum batadv_iv_flags {
84         BATADV_NOT_BEST_NEXT_HOP   = BIT(0),
85         BATADV_PRIMARIES_FIRST_HOP = BIT(1),
86         BATADV_DIRECTLINK          = BIT(2),
87 };
88
89 /* ICMP message types */
90 enum batadv_icmp_packettype {
91         BATADV_ECHO_REPLY              = 0,
92         BATADV_DESTINATION_UNREACHABLE = 3,
93         BATADV_ECHO_REQUEST            = 8,
94         BATADV_TTL_EXCEEDED            = 11,
95         BATADV_PARAMETER_PROBLEM       = 12,
96 };
97
98 /**
99  * enum batadv_mcast_flags - flags for multicast capabilities and settings
100  * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for
101  *  224.0.0.0/24 or ff02::1
102  * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets
103  * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets
104  */
105 enum batadv_mcast_flags {
106         BATADV_MCAST_WANT_ALL_UNSNOOPABLES      = BIT(0),
107         BATADV_MCAST_WANT_ALL_IPV4              = BIT(1),
108         BATADV_MCAST_WANT_ALL_IPV6              = BIT(2),
109 };
110
111 /* tt data subtypes */
112 #define BATADV_TT_DATA_TYPE_MASK 0x0F
113
114 /**
115  * enum batadv_tt_data_flags - flags for tt data tvlv
116  * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
117  * @BATADV_TT_REQUEST: TT request message
118  * @BATADV_TT_RESPONSE: TT response message
119  * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
120  */
121 enum batadv_tt_data_flags {
122         BATADV_TT_OGM_DIFF   = BIT(0),
123         BATADV_TT_REQUEST    = BIT(1),
124         BATADV_TT_RESPONSE   = BIT(2),
125         BATADV_TT_FULL_TABLE = BIT(4),
126 };
127
128 /**
129  * enum batadv_tt_client_flags - TT client specific flags
130  * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table
131  * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new
132  *  update telling its new real location has not been received/sent yet
133  * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface.
134  *  This information is used by the "AP Isolation" feature
135  * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This
136  *  information is used by the Extended Isolation feature
137  * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table
138  * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has
139  *  not been announced yet
140  * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept
141  *  in the table for one more originator interval for consistency purposes
142  * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of
143  *  the network but no nnode has already announced it
144  *
145  * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire.
146  * Bits from 8 to 15 are called _local flags_ because they are used for local
147  * computations only.
148  *
149  * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with
150  * the other nodes in the network. To achieve this goal these flags are included
151  * in the TT CRC computation.
152  */
153 enum batadv_tt_client_flags {
154         BATADV_TT_CLIENT_DEL     = BIT(0),
155         BATADV_TT_CLIENT_ROAM    = BIT(1),
156         BATADV_TT_CLIENT_WIFI    = BIT(4),
157         BATADV_TT_CLIENT_ISOLA   = BIT(5),
158         BATADV_TT_CLIENT_NOPURGE = BIT(8),
159         BATADV_TT_CLIENT_NEW     = BIT(9),
160         BATADV_TT_CLIENT_PENDING = BIT(10),
161         BATADV_TT_CLIENT_TEMP    = BIT(11),
162 };
163
164 /**
165  * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field
166  * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
167  */
168 enum batadv_vlan_flags {
169         BATADV_VLAN_HAS_TAG     = BIT(15),
170 };
171
172 /* claim frame types for the bridge loop avoidance */
173 enum batadv_bla_claimframe {
174         BATADV_CLAIM_TYPE_CLAIM         = 0x00,
175         BATADV_CLAIM_TYPE_UNCLAIM       = 0x01,
176         BATADV_CLAIM_TYPE_ANNOUNCE      = 0x02,
177         BATADV_CLAIM_TYPE_REQUEST       = 0x03,
178         BATADV_CLAIM_TYPE_LOOPDETECT    = 0x04,
179 };
180
181 /**
182  * enum batadv_tvlv_type - tvlv type definitions
183  * @BATADV_TVLV_GW: gateway tvlv
184  * @BATADV_TVLV_DAT: distributed arp table tvlv
185  * @BATADV_TVLV_NC: network coding tvlv
186  * @BATADV_TVLV_TT: translation table tvlv
187  * @BATADV_TVLV_ROAM: roaming advertisement tvlv
188  * @BATADV_TVLV_MCAST: multicast capability tvlv
189  */
190 enum batadv_tvlv_type {
191         BATADV_TVLV_GW          = 0x01,
192         BATADV_TVLV_DAT         = 0x02,
193         BATADV_TVLV_NC          = 0x03,
194         BATADV_TVLV_TT          = 0x04,
195         BATADV_TVLV_ROAM        = 0x05,
196         BATADV_TVLV_MCAST       = 0x06,
197 };
198
199 #pragma pack(2)
200 /* the destination hardware field in the ARP frame is used to
201  * transport the claim type and the group id
202  */
203 struct batadv_bla_claim_dst {
204         u8     magic[3];        /* FF:43:05 */
205         u8     type;            /* bla_claimframe */
206         __be16 group;           /* group id */
207 };
208
209 #pragma pack()
210
211 /**
212  * struct batadv_ogm_packet - ogm (routing protocol) packet
213  * @packet_type: batman-adv packet type, part of the general header
214  * @version: batman-adv protocol version, part of the genereal header
215  * @ttl: time to live for this packet, part of the genereal header
216  * @flags: contains routing relevant flags - see enum batadv_iv_flags
217  * @seqno: sequence identification
218  * @orig: address of the source node
219  * @prev_sender: address of the previous sender
220  * @reserved: reserved byte for alignment
221  * @tq: transmission quality
222  * @tvlv_len: length of tvlv data following the ogm header
223  */
224 struct batadv_ogm_packet {
225         u8     packet_type;
226         u8     version;
227         u8     ttl;
228         u8     flags;
229         __be32 seqno;
230         u8     orig[ETH_ALEN];
231         u8     prev_sender[ETH_ALEN];
232         u8     reserved;
233         u8     tq;
234         __be16 tvlv_len;
235         /* __packed is not needed as the struct size is divisible by 4,
236          * and the largest data type in this struct has a size of 4.
237          */
238 };
239
240 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
241
242 /**
243  * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
244  * @packet_type: batman-adv packet type, part of the general header
245  * @version: batman-adv protocol version, part of the general header
246  * @ttl: time to live for this packet, part of the general header
247  * @flags: reseved for routing relevant flags - currently always 0
248  * @seqno: sequence number
249  * @orig: originator mac address
250  * @tvlv_len: length of the appended tvlv buffer (in bytes)
251  * @throughput: the currently flooded path throughput
252  */
253 struct batadv_ogm2_packet {
254         u8     packet_type;
255         u8     version;
256         u8     ttl;
257         u8     flags;
258         __be32 seqno;
259         u8     orig[ETH_ALEN];
260         __be16 tvlv_len;
261         __be32 throughput;
262         /* __packed is not needed as the struct size is divisible by 4,
263          * and the largest data type in this struct has a size of 4.
264          */
265 };
266
267 #define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
268
269 /**
270  * struct batadv_elp_packet - elp (neighbor discovery) packet
271  * @packet_type: batman-adv packet type, part of the general header
272  * @version: batman-adv protocol version, part of the genereal header
273  * @orig: originator mac address
274  * @seqno: sequence number
275  * @elp_interval: currently used ELP sending interval in ms
276  */
277 struct batadv_elp_packet {
278         u8     packet_type;
279         u8     version;
280         u8     orig[ETH_ALEN];
281         __be32 seqno;
282         __be32 elp_interval;
283 };
284
285 #define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
286
287 /**
288  * struct batadv_icmp_header - common members among all the ICMP packets
289  * @packet_type: batman-adv packet type, part of the general header
290  * @version: batman-adv protocol version, part of the genereal header
291  * @ttl: time to live for this packet, part of the genereal header
292  * @msg_type: ICMP packet type
293  * @dst: address of the destination node
294  * @orig: address of the source node
295  * @uid: local ICMP socket identifier
296  * @align: not used - useful for alignment purposes only
297  *
298  * This structure is used for ICMP packets parsing only and it is never sent
299  * over the wire. The alignment field at the end is there to ensure that
300  * members are padded the same way as they are in real packets.
301  */
302 struct batadv_icmp_header {
303         u8 packet_type;
304         u8 version;
305         u8 ttl;
306         u8 msg_type; /* see ICMP message types above */
307         u8 dst[ETH_ALEN];
308         u8 orig[ETH_ALEN];
309         u8 uid;
310         u8 align[3];
311 };
312
313 /**
314  * struct batadv_icmp_packet - ICMP packet
315  * @packet_type: batman-adv packet type, part of the general header
316  * @version: batman-adv protocol version, part of the genereal header
317  * @ttl: time to live for this packet, part of the genereal header
318  * @msg_type: ICMP packet type
319  * @dst: address of the destination node
320  * @orig: address of the source node
321  * @uid: local ICMP socket identifier
322  * @reserved: not used - useful for alignment
323  * @seqno: ICMP sequence number
324  */
325 struct batadv_icmp_packet {
326         u8     packet_type;
327         u8     version;
328         u8     ttl;
329         u8     msg_type; /* see ICMP message types above */
330         u8     dst[ETH_ALEN];
331         u8     orig[ETH_ALEN];
332         u8     uid;
333         u8     reserved;
334         __be16 seqno;
335 };
336
337 #define BATADV_RR_LEN 16
338
339 /**
340  * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
341  * @packet_type: batman-adv packet type, part of the general header
342  * @version: batman-adv protocol version, part of the genereal header
343  * @ttl: time to live for this packet, part of the genereal header
344  * @msg_type: ICMP packet type
345  * @dst: address of the destination node
346  * @orig: address of the source node
347  * @uid: local ICMP socket identifier
348  * @rr_cur: number of entries the rr array
349  * @seqno: ICMP sequence number
350  * @rr: route record array
351  */
352 struct batadv_icmp_packet_rr {
353         u8     packet_type;
354         u8     version;
355         u8     ttl;
356         u8     msg_type; /* see ICMP message types above */
357         u8     dst[ETH_ALEN];
358         u8     orig[ETH_ALEN];
359         u8     uid;
360         u8     rr_cur;
361         __be16 seqno;
362         u8     rr[BATADV_RR_LEN][ETH_ALEN];
363 };
364
365 #define BATADV_ICMP_MAX_PACKET_SIZE     sizeof(struct batadv_icmp_packet_rr)
366
367 /* All packet headers in front of an ethernet header have to be completely
368  * divisible by 2 but not by 4 to make the payload after the ethernet
369  * header again 4 bytes boundary aligned.
370  *
371  * A packing of 2 is necessary to avoid extra padding at the end of the struct
372  * caused by a structure member which is larger than two bytes. Otherwise
373  * the structure would not fulfill the previously mentioned rule to avoid the
374  * misalignment of the payload after the ethernet header. It may also lead to
375  * leakage of information when the padding it not initialized before sending.
376  */
377 #pragma pack(2)
378
379 /**
380  * struct batadv_unicast_packet - unicast packet for network payload
381  * @packet_type: batman-adv packet type, part of the general header
382  * @version: batman-adv protocol version, part of the genereal header
383  * @ttl: time to live for this packet, part of the genereal header
384  * @ttvn: translation table version number
385  * @dest: originator destination of the unicast packet
386  */
387 struct batadv_unicast_packet {
388         u8 packet_type;
389         u8 version;
390         u8 ttl;
391         u8 ttvn; /* destination translation table version number */
392         u8 dest[ETH_ALEN];
393         /* "4 bytes boundary + 2 bytes" long to make the payload after the
394          * following ethernet header again 4 bytes boundary aligned
395          */
396 };
397
398 /**
399  * struct batadv_unicast_4addr_packet - extended unicast packet
400  * @u: common unicast packet header
401  * @src: address of the source
402  * @subtype: packet subtype
403  * @reserved: reserved byte for alignment
404  */
405 struct batadv_unicast_4addr_packet {
406         struct batadv_unicast_packet u;
407         u8 src[ETH_ALEN];
408         u8 subtype;
409         u8 reserved;
410         /* "4 bytes boundary + 2 bytes" long to make the payload after the
411          * following ethernet header again 4 bytes boundary aligned
412          */
413 };
414
415 /**
416  * struct batadv_frag_packet - fragmented packet
417  * @packet_type: batman-adv packet type, part of the general header
418  * @version: batman-adv protocol version, part of the genereal header
419  * @ttl: time to live for this packet, part of the genereal header
420  * @dest: final destination used when routing fragments
421  * @orig: originator of the fragment used when merging the packet
422  * @no: fragment number within this sequence
423  * @reserved: reserved byte for alignment
424  * @seqno: sequence identification
425  * @total_size: size of the merged packet
426  */
427 struct batadv_frag_packet {
428         u8     packet_type;
429         u8     version;  /* batman version field */
430         u8     ttl;
431 #if defined(__BIG_ENDIAN_BITFIELD)
432         u8     no:4;
433         u8     reserved:4;
434 #elif defined(__LITTLE_ENDIAN_BITFIELD)
435         u8     reserved:4;
436         u8     no:4;
437 #else
438 #error "unknown bitfield endianness"
439 #endif
440         u8     dest[ETH_ALEN];
441         u8     orig[ETH_ALEN];
442         __be16 seqno;
443         __be16 total_size;
444 };
445
446 /**
447  * struct batadv_bcast_packet - broadcast packet for network payload
448  * @packet_type: batman-adv packet type, part of the general header
449  * @version: batman-adv protocol version, part of the genereal header
450  * @ttl: time to live for this packet, part of the genereal header
451  * @reserved: reserved byte for alignment
452  * @seqno: sequence identification
453  * @orig: originator of the broadcast packet
454  */
455 struct batadv_bcast_packet {
456         u8     packet_type;
457         u8     version;  /* batman version field */
458         u8     ttl;
459         u8     reserved;
460         __be32 seqno;
461         u8     orig[ETH_ALEN];
462         /* "4 bytes boundary + 2 bytes" long to make the payload after the
463          * following ethernet header again 4 bytes boundary aligned
464          */
465 };
466
467 /**
468  * struct batadv_coded_packet - network coded packet
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  * @first_source: original source of first included packet
473  * @first_orig_dest: original destinal of first included packet
474  * @first_crc: checksum of first included packet
475  * @first_ttvn: tt-version number of first included packet
476  * @second_ttl: ttl of second packet
477  * @second_dest: second receiver of this coded packet
478  * @second_source: original source of second included packet
479  * @second_orig_dest: original destination of second included packet
480  * @second_crc: checksum of second included packet
481  * @second_ttvn: tt version number of second included packet
482  * @coded_len: length of network coded part of the payload
483  */
484 struct batadv_coded_packet {
485         u8     packet_type;
486         u8     version;  /* batman version field */
487         u8     ttl;
488         u8     first_ttvn;
489         /* u8  first_dest[ETH_ALEN]; - saved in mac header destination */
490         u8     first_source[ETH_ALEN];
491         u8     first_orig_dest[ETH_ALEN];
492         __be32 first_crc;
493         u8     second_ttl;
494         u8     second_ttvn;
495         u8     second_dest[ETH_ALEN];
496         u8     second_source[ETH_ALEN];
497         u8     second_orig_dest[ETH_ALEN];
498         __be32 second_crc;
499         __be16 coded_len;
500 };
501
502 #pragma pack()
503
504 /**
505  * struct batadv_unicast_tvlv_packet - generic unicast packet with tvlv payload
506  * @packet_type: batman-adv packet type, part of the general header
507  * @version: batman-adv protocol version, part of the genereal header
508  * @ttl: time to live for this packet, part of the genereal header
509  * @reserved: reserved field (for packet alignment)
510  * @src: address of the source
511  * @dst: address of the destination
512  * @tvlv_len: length of tvlv data following the unicast tvlv header
513  * @align: 2 bytes to align the header to a 4 byte boundary
514  */
515 struct batadv_unicast_tvlv_packet {
516         u8     packet_type;
517         u8     version;  /* batman version field */
518         u8     ttl;
519         u8     reserved;
520         u8     dst[ETH_ALEN];
521         u8     src[ETH_ALEN];
522         __be16 tvlv_len;
523         u16    align;
524 };
525
526 /**
527  * struct batadv_tvlv_hdr - base tvlv header struct
528  * @type: tvlv container type (see batadv_tvlv_type)
529  * @version: tvlv container version
530  * @len: tvlv container length
531  */
532 struct batadv_tvlv_hdr {
533         u8     type;
534         u8     version;
535         __be16 len;
536 };
537
538 /**
539  * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
540  *  container
541  * @bandwidth_down: advertised uplink download bandwidth
542  * @bandwidth_up: advertised uplink upload bandwidth
543  */
544 struct batadv_tvlv_gateway_data {
545         __be32 bandwidth_down;
546         __be32 bandwidth_up;
547 };
548
549 /**
550  * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
551  * @flags: translation table flags (see batadv_tt_data_flags)
552  * @ttvn: translation table version number
553  * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
554  *  one batadv_tvlv_tt_vlan_data object per announced vlan
555  */
556 struct batadv_tvlv_tt_data {
557         u8     flags;
558         u8     ttvn;
559         __be16 num_vlan;
560 };
561
562 /**
563  * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
564  *  the tt tvlv container
565  * @crc: crc32 checksum of the entries belonging to this vlan
566  * @vid: vlan identifier
567  * @reserved: unused, useful for alignment purposes
568  */
569 struct batadv_tvlv_tt_vlan_data {
570         __be32 crc;
571         __be16 vid;
572         u16    reserved;
573 };
574
575 /**
576  * struct batadv_tvlv_tt_change - translation table diff data
577  * @flags: status indicators concerning the non-mesh client (see
578  *  batadv_tt_client_flags)
579  * @reserved: reserved field - useful for alignment purposes only
580  * @addr: mac address of non-mesh client that triggered this tt change
581  * @vid: VLAN identifier
582  */
583 struct batadv_tvlv_tt_change {
584         u8     flags;
585         u8     reserved[3];
586         u8     addr[ETH_ALEN];
587         __be16 vid;
588 };
589
590 /**
591  * struct batadv_tvlv_roam_adv - roaming advertisement
592  * @client: mac address of roaming client
593  * @vid: VLAN identifier
594  */
595 struct batadv_tvlv_roam_adv {
596         u8     client[ETH_ALEN];
597         __be16 vid;
598 };
599
600 /**
601  * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
602  * @flags: multicast flags announced by the orig node
603  * @reserved: reserved field
604  */
605 struct batadv_tvlv_mcast_data {
606         u8 flags;
607         u8 reserved[3];
608 };
609
610 #endif /* _NET_BATMAN_ADV_PACKET_H_ */