net/batman-adv/packet.h

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