net/batman-adv/packet.h

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