net/batman-adv/packet.h

   1 /* Copyright (C) 2007-2013 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, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA
  18  */
  19
  20 #ifndef _NET_BATMAN_ADV_PACKET_H_
  21 #define _NET_BATMAN_ADV_PACKET_H_
  22
  23 /**
  24  * enum batadv_packettype - types for batman-adv encapsulated packets
  25  * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV
  26  * @BATADV_BCAST: broadcast packets carrying broadcast payload
  27  * @BATADV_CODED: network coded packets
  28  *
  29  * @BATADV_UNICAST: unicast packets carrying unicast payload traffic
  30  * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original
  31  *     payload packet
  32  * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of
  33  *     the sender
  34  * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute
  35  * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers
  36  */
  37 enum batadv_packettype {
  38         /* 0x00 - 0x3f: local packets or special rules for handling */
  39         BATADV_IV_OGM           = 0x00,
  40         BATADV_BCAST            = 0x01,
  41         BATADV_CODED            = 0x02,
  42         /* 0x40 - 0x7f: unicast */
  43 #define BATADV_UNICAST_MIN     0x40
  44         BATADV_UNICAST          = 0x40,
  45         BATADV_UNICAST_FRAG     = 0x41,
  46         BATADV_UNICAST_4ADDR    = 0x42,
  47         BATADV_ICMP             = 0x43,
  48         BATADV_UNICAST_TVLV     = 0x44,
  49 #define BATADV_UNICAST_MAX     0x7f
  50         /* 0x80 - 0xff: reserved */
  51 };
  52
  53 /**
  54  * enum batadv_subtype - packet subtype for unicast4addr
  55  * @BATADV_P_DATA: user payload
  56  * @BATADV_P_DAT_DHT_GET: DHT request message
  57  * @BATADV_P_DAT_DHT_PUT: DHT store message
  58  * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
  59  */
  60 enum batadv_subtype {
  61         BATADV_P_DATA                   = 0x01,
  62         BATADV_P_DAT_DHT_GET            = 0x02,
  63         BATADV_P_DAT_DHT_PUT            = 0x03,
  64         BATADV_P_DAT_CACHE_REPLY        = 0x04,
  65 };
  66
  67 /* this file is included by batctl which needs these defines */
  68 #define BATADV_COMPAT_VERSION 15
  69
  70 /**
  71  * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets
  72  * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was
  73  *     previously received from someone else than the best neighbor.
  74  * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address
  75  *     is used, and the packet travels its first hop.
  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 /* tt data subtypes */
  95 #define BATADV_TT_DATA_TYPE_MASK 0x0F
  96
  97 /**
  98  * enum batadv_tt_data_flags - flags for tt data tvlv
  99  * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
 100  * @BATADV_TT_REQUEST: TT request message
 101  * @BATADV_TT_RESPONSE: TT response message
 102  * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
 103  */
 104 enum batadv_tt_data_flags {
 105         BATADV_TT_OGM_DIFF   = BIT(0),
 106         BATADV_TT_REQUEST    = BIT(1),
 107         BATADV_TT_RESPONSE   = BIT(2),
 108         BATADV_TT_FULL_TABLE = BIT(4),
 109 };
 110
 111 /* BATADV_TT_CLIENT flags.
 112  * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
 113  * BIT(15) are used for local computation only
 114  */
 115 enum batadv_tt_client_flags {
 116         BATADV_TT_CLIENT_DEL     = BIT(0),
 117         BATADV_TT_CLIENT_ROAM    = BIT(1),
 118         BATADV_TT_CLIENT_WIFI    = BIT(2),
 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 /* the destination hardware field in the ARP frame is used to
 158  * transport the claim type and the group id
 159  */
 160 struct batadv_bla_claim_dst {
 161         uint8_t magic[3];       /* FF:43:05 */
 162         uint8_t type;           /* bla_claimframe */
 163         __be16 group;           /* group id */
 164 };
 165
 166 struct batadv_header {
 167         uint8_t  packet_type;
 168         uint8_t  version;  /* batman version field */
 169         uint8_t  ttl;
 170         /* the parent struct has to add a byte after the header to make
 171          * everything 4 bytes aligned again
 172          */
 173 };
 174
 175 /**
 176  * struct batadv_ogm_packet - ogm (routing protocol) packet
 177  * @header: common batman packet header
 178  * @flags: contains routing relevant flags - see enum batadv_iv_flags
 179  * @tvlv_len: length of tvlv data following the ogm header
 180  */
 181 struct batadv_ogm_packet {
 182         struct batadv_header header;
 183         uint8_t  flags;
 184         __be32   seqno;
 185         uint8_t  orig[ETH_ALEN];
 186         uint8_t  prev_sender[ETH_ALEN];
 187         uint8_t  reserved;
 188         uint8_t  tq;
 189         __be16   tvlv_len;
 190         /* __packed is not needed as the struct size is divisible by 4,
 191          * and the largest data type in this struct has a size of 4.
 192          */
 193 };
 194
 195 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
 196
 197 /**
 198  * batadv_icmp_header - common ICMP header
 199  * @header: common batman header
 200  * @msg_type: ICMP packet type
 201  * @dst: address of the destination node
 202  * @orig: address of the source node
 203  * @uid: local ICMP socket identifier
 204  */
 205 struct batadv_icmp_header {
 206         struct batadv_header header;
 207         uint8_t  msg_type; /* see ICMP message types above */
 208         uint8_t  dst[ETH_ALEN];
 209         uint8_t  orig[ETH_ALEN];
 210         uint8_t  uid;
 211 };
 212
 213 /**
 214  * batadv_icmp_packet - ICMP packet
 215  * @icmph: common ICMP header
 216  * @reserved: not used - useful for alignment
 217  * @seqno: ICMP sequence number
 218  */
 219 struct batadv_icmp_packet {
 220         struct batadv_icmp_header icmph;
 221         uint8_t  reserved;
 222         __be16   seqno;
 223 };
 224
 225 #define BATADV_RR_LEN 16
 226
 227 /**
 228  * batadv_icmp_packet_rr - ICMP RouteRecord packet
 229  * @icmph: common ICMP header
 230  * @rr_cur: number of entries the rr array
 231  * @seqno: ICMP sequence number
 232  * @rr: route record array
 233  */
 234 struct batadv_icmp_packet_rr {
 235         struct batadv_icmp_header icmph;
 236         uint8_t  rr_cur;
 237         __be16   seqno;
 238         uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
 239 };
 240
 241 /* All packet headers in front of an ethernet header have to be completely
 242  * divisible by 2 but not by 4 to make the payload after the ethernet
 243  * header again 4 bytes boundary aligned.
 244  *
 245  * A packing of 2 is necessary to avoid extra padding at the end of the struct
 246  * caused by a structure member which is larger than two bytes. Otherwise
 247  * the structure would not fulfill the previously mentioned rule to avoid the
 248  * misalignment of the payload after the ethernet header. It may also lead to
 249  * leakage of information when the padding it not initialized before sending.
 250  */
 251 #pragma pack(2)
 252
 253 struct batadv_unicast_packet {
 254         struct batadv_header header;
 255         uint8_t  ttvn; /* destination translation table version number */
 256         uint8_t  dest[ETH_ALEN];
 257         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 258          * following ethernet header again 4 bytes boundary aligned
 259          */
 260 };
 261
 262 /**
 263  * struct batadv_unicast_4addr_packet - extended unicast packet
 264  * @u: common unicast packet header
 265  * @src: address of the source
 266  * @subtype: packet subtype
 267  */
 268 struct batadv_unicast_4addr_packet {
 269         struct batadv_unicast_packet u;
 270         uint8_t src[ETH_ALEN];
 271         uint8_t subtype;
 272         uint8_t reserved;
 273         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 274          * following ethernet header again 4 bytes boundary aligned
 275          */
 276 };
 277
 278 /**
 279  * struct batadv_frag_packet - fragmented packet
 280  * @header: common batman packet header with type, compatversion, and ttl
 281  * @dest: final destination used when routing fragments
 282  * @orig: originator of the fragment used when merging the packet
 283  * @no: fragment number within this sequence
 284  * @reserved: reserved byte for alignment
 285  * @seqno: sequence identification
 286  * @total_size: size of the merged packet
 287  */
 288 struct batadv_frag_packet {
 289         struct  batadv_header header;
 290 #if defined(__BIG_ENDIAN_BITFIELD)
 291         uint8_t no:4;
 292         uint8_t reserved:4;
 293 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 294         uint8_t reserved:4;
 295         uint8_t no:4;
 296 #else
 297 #error "unknown bitfield endianess"
 298 #endif
 299         uint8_t dest[ETH_ALEN];
 300         uint8_t orig[ETH_ALEN];
 301         __be16  seqno;
 302         __be16  total_size;
 303 };
 304
 305 struct batadv_bcast_packet {
 306         struct batadv_header header;
 307         uint8_t  reserved;
 308         __be32   seqno;
 309         uint8_t  orig[ETH_ALEN];
 310         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 311          * following ethernet header again 4 bytes boundary aligned
 312          */
 313 };
 314
 315 #pragma pack()
 316
 317 /**
 318  * struct batadv_coded_packet - network coded packet
 319  * @header: common batman packet header and ttl of first included packet
 320  * @reserved: Align following fields to 2-byte boundaries
 321  * @first_source: original source of first included packet
 322  * @first_orig_dest: original destinal of first included packet
 323  * @first_crc: checksum of first included packet
 324  * @first_ttvn: tt-version number of first included packet
 325  * @second_ttl: ttl of second packet
 326  * @second_dest: second receiver of this coded packet
 327  * @second_source: original source of second included packet
 328  * @second_orig_dest: original destination of second included packet
 329  * @second_crc: checksum of second included packet
 330  * @second_ttvn: tt version number of second included packet
 331  * @coded_len: length of network coded part of the payload
 332  */
 333 struct batadv_coded_packet {
 334         struct batadv_header header;
 335         uint8_t  first_ttvn;
 336         /* uint8_t  first_dest[ETH_ALEN]; - saved in mac header destination */
 337         uint8_t  first_source[ETH_ALEN];
 338         uint8_t  first_orig_dest[ETH_ALEN];
 339         __be32   first_crc;
 340         uint8_t  second_ttl;
 341         uint8_t  second_ttvn;
 342         uint8_t  second_dest[ETH_ALEN];
 343         uint8_t  second_source[ETH_ALEN];
 344         uint8_t  second_orig_dest[ETH_ALEN];
 345         __be32   second_crc;
 346         __be16   coded_len;
 347 };
 348
 349 /**
 350  * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
 351  * @header: common batman packet header
 352  * @reserved: reserved field (for packet alignment)
 353  * @src: address of the source
 354  * @dst: address of the destination
 355  * @tvlv_len: length of tvlv data following the unicast tvlv header
 356  * @align: 2 bytes to align the header to a 4 byte boundry
 357  */
 358 struct batadv_unicast_tvlv_packet {
 359         struct batadv_header header;
 360         uint8_t  reserved;
 361         uint8_t  dst[ETH_ALEN];
 362         uint8_t  src[ETH_ALEN];
 363         __be16   tvlv_len;
 364         uint16_t align;
 365 };
 366
 367 /**
 368  * struct batadv_tvlv_hdr - base tvlv header struct
 369  * @type: tvlv container type (see batadv_tvlv_type)
 370  * @version: tvlv container version
 371  * @len: tvlv container length
 372  */
 373 struct batadv_tvlv_hdr {
 374         uint8_t type;
 375         uint8_t version;
 376         __be16  len;
 377 };
 378
 379 /**
 380  * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
 381  *  container
 382  * @bandwidth_down: advertised uplink download bandwidth
 383  * @bandwidth_up: advertised uplink upload bandwidth
 384  */
 385 struct batadv_tvlv_gateway_data {
 386         __be32 bandwidth_down;
 387         __be32 bandwidth_up;
 388 };
 389
 390 /**
 391  * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
 392  * @flags: translation table flags (see batadv_tt_data_flags)
 393  * @ttvn: translation table version number
 394  * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
 395  *  one batadv_tvlv_tt_vlan_data object per announced vlan
 396  */
 397 struct batadv_tvlv_tt_data {
 398         uint8_t flags;
 399         uint8_t ttvn;
 400         __be16  num_vlan;
 401 };
 402
 403 /**
 404  * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through
 405  *  the tt tvlv container
 406  * @crc: crc32 checksum of the entries belonging to this vlan
 407  * @vid: vlan identifier
 408  * @reserved: unused, useful for alignment purposes
 409  */
 410 struct batadv_tvlv_tt_vlan_data {
 411         __be32  crc;
 412         __be16  vid;
 413         uint16_t reserved;
 414 };
 415
 416 /**
 417  * struct batadv_tvlv_tt_change - translation table diff data
 418  * @flags: status indicators concerning the non-mesh client (see
 419  *  batadv_tt_client_flags)
 420  * @reserved: reserved field
 421  * @addr: mac address of non-mesh client that triggered this tt change
 422  * @vid: VLAN identifier
 423  */
 424 struct batadv_tvlv_tt_change {
 425         uint8_t flags;
 426         uint8_t reserved;
 427         uint8_t addr[ETH_ALEN];
 428         __be16 vid;
 429 };
 430
 431 /**
 432  * struct batadv_tvlv_roam_adv - roaming advertisement
 433  * @client: mac address of roaming client
 434  * @vid: VLAN identifier
 435  */
 436 struct batadv_tvlv_roam_adv {
 437         uint8_t  client[ETH_ALEN];
 438         __be16 vid;
 439 };
 440
 441 #endif /* _NET_BATMAN_ADV_PACKET_H_ */