Merge tag 'xtensa-next-20160320' of git://github.com/czankel/xtensa-linux
[linux-2.6-block.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 };
179
180 /**
181  * enum batadv_tvlv_type - tvlv type definitions
182  * @BATADV_TVLV_GW: gateway tvlv
183  * @BATADV_TVLV_DAT: distributed arp table tvlv
184  * @BATADV_TVLV_NC: network coding tvlv
185  * @BATADV_TVLV_TT: translation table tvlv
186  * @BATADV_TVLV_ROAM: roaming advertisement tvlv
187  * @BATADV_TVLV_MCAST: multicast capability tvlv
188  */
189 enum batadv_tvlv_type {
190         BATADV_TVLV_GW          = 0x01,
191         BATADV_TVLV_DAT         = 0x02,
192         BATADV_TVLV_NC          = 0x03,
193         BATADV_TVLV_TT          = 0x04,
194         BATADV_TVLV_ROAM        = 0x05,
195         BATADV_TVLV_MCAST       = 0x06,
196 };
197
198 #pragma pack(2)
199 /* the destination hardware field in the ARP frame is used to
200  * transport the claim type and the group id
201  */
202 struct batadv_bla_claim_dst {
203         u8     magic[3];        /* FF:43:05 */
204         u8     type;            /* bla_claimframe */
205         __be16 group;           /* group id */
206 };
207
208 #pragma pack()
209
210 /**
211  * struct batadv_ogm_packet - ogm (routing protocol) packet
212  * @packet_type: batman-adv packet type, part of the general header
213  * @version: batman-adv protocol version, part of the genereal header
214  * @ttl: time to live for this packet, part of the genereal header
215  * @flags: contains routing relevant flags - see enum batadv_iv_flags
216  * @seqno: sequence identification
217  * @orig: address of the source node
218  * @prev_sender: address of the previous sender
219  * @reserved: reserved byte for alignment
220  * @tq: transmission quality
221  * @tvlv_len: length of tvlv data following the ogm header
222  */
223 struct batadv_ogm_packet {
224         u8     packet_type;
225         u8     version;
226         u8     ttl;
227         u8     flags;
228         __be32 seqno;
229         u8     orig[ETH_ALEN];
230         u8     prev_sender[ETH_ALEN];
231         u8     reserved;
232         u8     tq;
233         __be16 tvlv_len;
234         /* __packed is not needed as the struct size is divisible by 4,
235          * and the largest data type in this struct has a size of 4.
236          */
237 };
238
239 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
240
241 /**
242  * struct batadv_ogm2_packet - ogm2 (routing protocol) packet
243  * @packet_type: batman-adv packet type, part of the general header
244  * @version: batman-adv protocol version, part of the general header
245  * @ttl: time to live for this packet, part of the general header
246  * @flags: reseved for routing relevant flags - currently always 0
247  * @seqno: sequence number
248  * @orig: originator mac address
249  * @tvlv_len: length of the appended tvlv buffer (in bytes)
250  * @throughput: the currently flooded path throughput
251  */
252 struct batadv_ogm2_packet {
253         u8     packet_type;
254         u8     version;
255         u8     ttl;
256         u8     flags;
257         __be32 seqno;
258         u8     orig[ETH_ALEN];
259         __be16 tvlv_len;
260         __be32 throughput;
261         /* __packed is not needed as the struct size is divisible by 4,
262          * and the largest data type in this struct has a size of 4.
263          */
264 };
265
266 #define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet)
267
268 /**
269  * struct batadv_elp_packet - elp (neighbor discovery) packet
270  * @packet_type: batman-adv packet type, part of the general header
271  * @version: batman-adv protocol version, part of the genereal header
272  * @orig: originator mac address
273  * @seqno: sequence number
274  * @elp_interval: currently used ELP sending interval in ms
275  */
276 struct batadv_elp_packet {
277         u8     packet_type;
278         u8     version;
279         u8     orig[ETH_ALEN];
280         __be32 seqno;
281         __be32 elp_interval;
282 };
283
284 #define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet)
285
286 /**
287  * struct batadv_icmp_header - common members among all the ICMP packets
288  * @packet_type: batman-adv packet type, part of the general header
289  * @version: batman-adv protocol version, part of the genereal header
290  * @ttl: time to live for this packet, part of the genereal header
291  * @msg_type: ICMP packet type
292  * @dst: address of the destination node
293  * @orig: address of the source node
294  * @uid: local ICMP socket identifier
295  * @align: not used - useful for alignment purposes only
296  *
297  * This structure is used for ICMP packets parsing only and it is never sent
298  * over the wire. The alignment field at the end is there to ensure that
299  * members are padded the same way as they are in real packets.
300  */
301 struct batadv_icmp_header {
302         u8 packet_type;
303         u8 version;
304         u8 ttl;
305         u8 msg_type; /* see ICMP message types above */
306         u8 dst[ETH_ALEN];
307         u8 orig[ETH_ALEN];
308         u8 uid;
309         u8 align[3];
310 };
311
312 /**
313  * struct batadv_icmp_packet - ICMP packet
314  * @packet_type: batman-adv packet type, part of the general header
315  * @version: batman-adv protocol version, part of the genereal header
316  * @ttl: time to live for this packet, part of the genereal header
317  * @msg_type: ICMP packet type
318  * @dst: address of the destination node
319  * @orig: address of the source node
320  * @uid: local ICMP socket identifier
321  * @reserved: not used - useful for alignment
322  * @seqno: ICMP sequence number
323  */
324 struct batadv_icmp_packet {
325         u8     packet_type;
326         u8     version;
327         u8     ttl;
328         u8     msg_type; /* see ICMP message types above */
329         u8     dst[ETH_ALEN];
330         u8     orig[ETH_ALEN];
331         u8     uid;
332         u8     reserved;
333         __be16 seqno;
334 };
335
336 #define BATADV_RR_LEN 16
337
338 /**
339  * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
340  * @packet_type: batman-adv packet type, part of the general header
341  * @version: batman-adv protocol version, part of the genereal header
342  * @ttl: time to live for this packet, part of the genereal header
343  * @msg_type: ICMP packet type
344  * @dst: address of the destination node
345  * @orig: address of the source node
346  * @uid: local ICMP socket identifier
347  * @rr_cur: number of entries the rr array
348  * @seqno: ICMP sequence number
349  * @rr: route record array
350  */
351 struct batadv_icmp_packet_rr {
352         u8     packet_type;
353         u8     version;
354         u8     ttl;
355         u8     msg_type; /* see ICMP message types above */
356         u8     dst[ETH_ALEN];
357         u8     orig[ETH_ALEN];
358         u8     uid;
359         u8     rr_cur;
360         __be16 seqno;
361         u8     rr[BATADV_RR_LEN][ETH_ALEN];
362 };
363
364 #define BATADV_ICMP_MAX_PACKET_SIZE     sizeof(struct batadv_icmp_packet_rr)
365
366 /* All packet headers in front of an ethernet header have to be completely
367  * divisible by 2 but not by 4 to make the payload after the ethernet
368  * header again 4 bytes boundary aligned.
369  *
370  * A packing of 2 is necessary to avoid extra padding at the end of the struct
371  * caused by a structure member which is larger than two bytes. Otherwise
372  * the structure would not fulfill the previously mentioned rule to avoid the
373  * misalignment of the payload after the ethernet header. It may also lead to
374  * leakage of information when the padding it not initialized before sending.
375  */
376 #pragma pack(2)
377
378 /**
379  * struct batadv_unicast_packet - unicast packet for network payload
380  * @packet_type: batman-adv packet type, part of the general header
381  * @version: batman-adv protocol version, part of the genereal header
382  * @ttl: time to live for this packet, part of the genereal header
383  * @ttvn: translation table version number
384  * @dest: originator destination of the unicast packet
385  */
386 struct batadv_unicast_packet {
387         u8 packet_type;
388         u8 version;
389         u8 ttl;
390         u8 ttvn; /* destination translation table version number */
391         u8 dest[ETH_ALEN];
392         /* "4 bytes boundary + 2 bytes" long to make the payload after the
393          * following ethernet header again 4 bytes boundary aligned
394          */
395 };
396
397 /**
398  * struct batadv_unicast_4addr_packet - extended unicast packet
399  * @u: common unicast packet header
400  * @src: address of the source
401  * @subtype: packet subtype
402  * @reserved: reserved byte for alignment
403  */
404 struct batadv_unicast_4addr_packet {
405         struct batadv_unicast_packet u;
406         u8 src[ETH_ALEN];
407         u8 subtype;
408         u8 reserved;
409         /* "4 bytes boundary + 2 bytes" long to make the payload after the
410          * following ethernet header again 4 bytes boundary aligned
411          */
412 };
413
414 /**
415  * struct batadv_frag_packet - fragmented packet
416  * @packet_type: batman-adv packet type, part of the general header
417  * @version: batman-adv protocol version, part of the genereal header
418  * @ttl: time to live for this packet, part of the genereal header
419  * @dest: final destination used when routing fragments
420  * @orig: originator of the fragment used when merging the packet
421  * @no: fragment number within this sequence
422  * @reserved: reserved byte for alignment
423  * @seqno: sequence identification
424  * @total_size: size of the merged packet
425  */
426 struct batadv_frag_packet {
427         u8     packet_type;
428         u8     version;  /* batman version field */
429         u8     ttl;
430 #if defined(__BIG_ENDIAN_BITFIELD)
431         u8     no:4;
432         u8     reserved:4;
433 #elif defined(__LITTLE_ENDIAN_BITFIELD)
434         u8     reserved:4;
435         u8     no:4;
436 #else
437 #error "unknown bitfield endianness"
438 #endif
439         u8     dest[ETH_ALEN];
440         u8     orig[ETH_ALEN];
441         __be16 seqno;
442         __be16 total_size;
443 };
444
445 /**
446  * struct batadv_bcast_packet - broadcast packet for network payload
447  * @packet_type: batman-adv packet type, part of the general header
448  * @version: batman-adv protocol version, part of the genereal header
449  * @ttl: time to live for this packet, part of the genereal header
450  * @reserved: reserved byte for alignment
451  * @seqno: sequence identification
452  * @orig: originator of the broadcast packet
453  */
454 struct batadv_bcast_packet {
455         u8     packet_type;
456         u8     version;  /* batman version field */
457         u8     ttl;
458         u8     reserved;
459         __be32 seqno;
460         u8     orig[ETH_ALEN];
461         /* "4 bytes boundary + 2 bytes" long to make the payload after the
462          * following ethernet header again 4 bytes boundary aligned
463          */
464 };
465
466 /**
467  * struct batadv_coded_packet - network coded packet
468  * @packet_type: batman-adv packet type, part of the general header
469  * @version: batman-adv protocol version, part of the genereal header
470  * @ttl: time to live for this packet, part of the genereal header
471  * @first_source: original source of first included packet
472  * @first_orig_dest: original destinal of first included packet
473  * @first_crc: checksum of first included packet
474  * @first_ttvn: tt-version number of first included packet
475  * @second_ttl: ttl of second packet
476  * @second_dest: second receiver of this coded packet
477  * @second_source: original source of second included packet
478  * @second_orig_dest: original destination of second included packet
479  * @second_crc: checksum of second included packet
480  * @second_ttvn: tt version number of second included packet
481  * @coded_len: length of network coded part of the payload
482  */
483 struct batadv_coded_packet {
484         u8     packet_type;
485         u8     version;  /* batman version field */
486         u8     ttl;
487         u8     first_ttvn;
488         /* u8  first_dest[ETH_ALEN]; - saved in mac header destination */
489         u8     first_source[ETH_ALEN];
490         u8     first_orig_dest[ETH_ALEN];
491         __be32 first_crc;
492         u8     second_ttl;
493         u8     second_ttvn;
494         u8     second_dest[ETH_ALEN];
495         u8     second_source[ETH_ALEN];
496         u8     second_orig_dest[ETH_ALEN];
497         __be32 second_crc;
498         __be16 coded_len;
499 };
500
501 #pragma pack()
502
503 /**
504  * struct batadv_unicast_tvlv - generic unicast packet with tvlv 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 field (for packet alignment)
509  * @src: address of the source
510  * @dst: address of the destination
511  * @tvlv_len: length of tvlv data following the unicast tvlv header
512  * @align: 2 bytes to align the header to a 4 byte boundary
513  */
514 struct batadv_unicast_tvlv_packet {
515         u8     packet_type;
516         u8     version;  /* batman version field */
517         u8     ttl;
518         u8     reserved;
519         u8     dst[ETH_ALEN];
520         u8     src[ETH_ALEN];
521         __be16 tvlv_len;
522         u16    align;
523 };
524
525 /**
526  * struct batadv_tvlv_hdr - base tvlv header struct
527  * @type: tvlv container type (see batadv_tvlv_type)
528  * @version: tvlv container version
529  * @len: tvlv container length
530  */
531 struct batadv_tvlv_hdr {
532         u8     type;
533         u8     version;
534         __be16 len;
535 };
536
537 /**
538  * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
539  *  container
540  * @bandwidth_down: advertised uplink download bandwidth
541  * @bandwidth_up: advertised uplink upload bandwidth
542  */
543 struct batadv_tvlv_gateway_data {
544         __be32 bandwidth_down;
545         __be32 bandwidth_up;
546 };
547
548 /**
549  * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
550  * @flags: translation table flags (see batadv_tt_data_flags)
551  * @ttvn: translation table version number
552  * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
553  *  one batadv_tvlv_tt_vlan_data object per announced vlan
554  */
555 struct batadv_tvlv_tt_data {
556         u8     flags;
557         u8     ttvn;
558         __be16 num_vlan;
559 };
560
561 /**
562  * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
563  *  the tt tvlv container
564  * @crc: crc32 checksum of the entries belonging to this vlan
565  * @vid: vlan identifier
566  * @reserved: unused, useful for alignment purposes
567  */
568 struct batadv_tvlv_tt_vlan_data {
569         __be32 crc;
570         __be16 vid;
571         u16    reserved;
572 };
573
574 /**
575  * struct batadv_tvlv_tt_change - translation table diff data
576  * @flags: status indicators concerning the non-mesh client (see
577  *  batadv_tt_client_flags)
578  * @reserved: reserved field - useful for alignment purposes only
579  * @addr: mac address of non-mesh client that triggered this tt change
580  * @vid: VLAN identifier
581  */
582 struct batadv_tvlv_tt_change {
583         u8     flags;
584         u8     reserved[3];
585         u8     addr[ETH_ALEN];
586         __be16 vid;
587 };
588
589 /**
590  * struct batadv_tvlv_roam_adv - roaming advertisement
591  * @client: mac address of roaming client
592  * @vid: VLAN identifier
593  */
594 struct batadv_tvlv_roam_adv {
595         u8     client[ETH_ALEN];
596         __be16 vid;
597 };
598
599 /**
600  * struct batadv_tvlv_mcast_data - payload of a multicast tvlv
601  * @flags: multicast flags announced by the orig node
602  * @reserved: reserved field
603  */
604 struct batadv_tvlv_mcast_data {
605         u8 flags;
606         u8 reserved[3];
607 };
608
609 #endif /* _NET_BATMAN_ADV_PACKET_H_ */