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 /* fragmentation defines */
  95 enum batadv_unicast_frag_flags {
  96         BATADV_UNI_FRAG_HEAD      = BIT(0),
  97         BATADV_UNI_FRAG_LARGETAIL = BIT(1),
  98 };
  99
 100 /* tt data subtypes */
 101 #define BATADV_TT_DATA_TYPE_MASK 0x0F
 102
 103 /**
 104  * enum batadv_tt_data_flags - flags for tt data tvlv
 105  * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
 106  * @BATADV_TT_REQUEST: TT request message
 107  * @BATADV_TT_RESPONSE: TT response message
 108  * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
 109  */
 110 enum batadv_tt_data_flags {
 111         BATADV_TT_OGM_DIFF   = BIT(0),
 112         BATADV_TT_REQUEST    = BIT(1),
 113         BATADV_TT_RESPONSE   = BIT(2),
 114         BATADV_TT_FULL_TABLE = BIT(4),
 115 };
 116
 117 /* BATADV_TT_CLIENT flags.
 118  * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
 119  * BIT(15) are used for local computation only
 120  */
 121 enum batadv_tt_client_flags {
 122         BATADV_TT_CLIENT_DEL     = BIT(0),
 123         BATADV_TT_CLIENT_ROAM    = BIT(1),
 124         BATADV_TT_CLIENT_WIFI    = BIT(2),
 125         BATADV_TT_CLIENT_NOPURGE = BIT(8),
 126         BATADV_TT_CLIENT_NEW     = BIT(9),
 127         BATADV_TT_CLIENT_PENDING = BIT(10),
 128         BATADV_TT_CLIENT_TEMP    = BIT(11),
 129 };
 130
 131 /* claim frame types for the bridge loop avoidance */
 132 enum batadv_bla_claimframe {
 133         BATADV_CLAIM_TYPE_CLAIM         = 0x00,
 134         BATADV_CLAIM_TYPE_UNCLAIM       = 0x01,
 135         BATADV_CLAIM_TYPE_ANNOUNCE      = 0x02,
 136         BATADV_CLAIM_TYPE_REQUEST       = 0x03,
 137 };
 138
 139 /**
 140  * enum batadv_tvlv_type - tvlv type definitions
 141  * @BATADV_TVLV_GW: gateway tvlv
 142  * @BATADV_TVLV_DAT: distributed arp table tvlv
 143  * @BATADV_TVLV_NC: network coding tvlv
 144  * @BATADV_TVLV_TT: translation table tvlv
 145  * @BATADV_TVLV_ROAM: roaming advertisement tvlv
 146  */
 147 enum batadv_tvlv_type {
 148         BATADV_TVLV_GW          = 0x01,
 149         BATADV_TVLV_DAT         = 0x02,
 150         BATADV_TVLV_NC          = 0x03,
 151         BATADV_TVLV_TT          = 0x04,
 152         BATADV_TVLV_ROAM        = 0x05,
 153 };
 154
 155 /* the destination hardware field in the ARP frame is used to
 156  * transport the claim type and the group id
 157  */
 158 struct batadv_bla_claim_dst {
 159         uint8_t magic[3];       /* FF:43:05 */
 160         uint8_t type;           /* bla_claimframe */
 161         __be16 group;           /* group id */
 162 };
 163
 164 struct batadv_header {
 165         uint8_t  packet_type;
 166         uint8_t  version;  /* batman version field */
 167         uint8_t  ttl;
 168         /* the parent struct has to add a byte after the header to make
 169          * everything 4 bytes aligned again
 170          */
 171 };
 172
 173 /**
 174  * struct batadv_ogm_packet - ogm (routing protocol) packet
 175  * @header: common batman packet header
 176  * @flags: contains routing relevant flags - see enum batadv_iv_flags
 177  * @tvlv_len: length of tvlv data following the ogm header
 178  */
 179 struct batadv_ogm_packet {
 180         struct batadv_header header;
 181         uint8_t  flags;
 182         __be32   seqno;
 183         uint8_t  orig[ETH_ALEN];
 184         uint8_t  prev_sender[ETH_ALEN];
 185         uint8_t  reserved;
 186         uint8_t  tq;
 187         __be16   tvlv_len;
 188         /* __packed is not needed as the struct size is divisible by 4,
 189          * and the largest data type in this struct has a size of 4.
 190          */
 191 };
 192
 193 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
 194
 195 struct batadv_icmp_packet {
 196         struct batadv_header header;
 197         uint8_t  msg_type; /* see ICMP message types above */
 198         uint8_t  dst[ETH_ALEN];
 199         uint8_t  orig[ETH_ALEN];
 200         __be16   seqno;
 201         uint8_t  uid;
 202         uint8_t  reserved;
 203 };
 204
 205 #define BATADV_RR_LEN 16
 206
 207 /* icmp_packet_rr must start with all fields from imcp_packet
 208  * as this is assumed by code that handles ICMP packets
 209  */
 210 struct batadv_icmp_packet_rr {
 211         struct batadv_header header;
 212         uint8_t  msg_type; /* see ICMP message types above */
 213         uint8_t  dst[ETH_ALEN];
 214         uint8_t  orig[ETH_ALEN];
 215         __be16   seqno;
 216         uint8_t  uid;
 217         uint8_t  rr_cur;
 218         uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
 219 };
 220
 221 /* All packet headers in front of an ethernet header have to be completely
 222  * divisible by 2 but not by 4 to make the payload after the ethernet
 223  * header again 4 bytes boundary aligned.
 224  *
 225  * A packing of 2 is necessary to avoid extra padding at the end of the struct
 226  * caused by a structure member which is larger than two bytes. Otherwise
 227  * the structure would not fulfill the previously mentioned rule to avoid the
 228  * misalignment of the payload after the ethernet header. It may also lead to
 229  * leakage of information when the padding it not initialized before sending.
 230  */
 231 #pragma pack(2)
 232
 233 struct batadv_unicast_packet {
 234         struct batadv_header header;
 235         uint8_t  ttvn; /* destination translation table version number */
 236         uint8_t  dest[ETH_ALEN];
 237         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 238          * following ethernet header again 4 bytes boundary aligned
 239          */
 240 };
 241
 242 /**
 243  * struct batadv_unicast_4addr_packet - extended unicast packet
 244  * @u: common unicast packet header
 245  * @src: address of the source
 246  * @subtype: packet subtype
 247  */
 248 struct batadv_unicast_4addr_packet {
 249         struct batadv_unicast_packet u;
 250         uint8_t src[ETH_ALEN];
 251         uint8_t subtype;
 252         uint8_t reserved;
 253         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 254          * following ethernet header again 4 bytes boundary aligned
 255          */
 256 };
 257
 258 struct batadv_unicast_frag_packet {
 259         struct batadv_header header;
 260         uint8_t  ttvn; /* destination translation table version number */
 261         uint8_t  dest[ETH_ALEN];
 262         uint8_t  flags;
 263         uint8_t  align;
 264         uint8_t  orig[ETH_ALEN];
 265         __be16   seqno;
 266 } __packed;
 267
 268 struct batadv_bcast_packet {
 269         struct batadv_header header;
 270         uint8_t  reserved;
 271         __be32   seqno;
 272         uint8_t  orig[ETH_ALEN];
 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 #pragma pack()
 279
 280 /**
 281  * struct batadv_coded_packet - network coded packet
 282  * @header: common batman packet header and ttl of first included packet
 283  * @reserved: Align following fields to 2-byte boundaries
 284  * @first_source: original source of first included packet
 285  * @first_orig_dest: original destinal of first included packet
 286  * @first_crc: checksum of first included packet
 287  * @first_ttvn: tt-version number of first included packet
 288  * @second_ttl: ttl of second packet
 289  * @second_dest: second receiver of this coded packet
 290  * @second_source: original source of second included packet
 291  * @second_orig_dest: original destination of second included packet
 292  * @second_crc: checksum of second included packet
 293  * @second_ttvn: tt version number of second included packet
 294  * @coded_len: length of network coded part of the payload
 295  */
 296 struct batadv_coded_packet {
 297         struct batadv_header header;
 298         uint8_t  first_ttvn;
 299         /* uint8_t  first_dest[ETH_ALEN]; - saved in mac header destination */
 300         uint8_t  first_source[ETH_ALEN];
 301         uint8_t  first_orig_dest[ETH_ALEN];
 302         __be32   first_crc;
 303         uint8_t  second_ttl;
 304         uint8_t  second_ttvn;
 305         uint8_t  second_dest[ETH_ALEN];
 306         uint8_t  second_source[ETH_ALEN];
 307         uint8_t  second_orig_dest[ETH_ALEN];
 308         __be32   second_crc;
 309         __be16   coded_len;
 310 };
 311
 312 /**
 313  * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
 314  * @header: common batman packet header
 315  * @reserved: reserved field (for packet alignment)
 316  * @src: address of the source
 317  * @dst: address of the destination
 318  * @tvlv_len: length of tvlv data following the unicast tvlv header
 319  * @align: 2 bytes to align the header to a 4 byte boundry
 320  */
 321 struct batadv_unicast_tvlv_packet {
 322         struct batadv_header header;
 323         uint8_t  reserved;
 324         uint8_t  dst[ETH_ALEN];
 325         uint8_t  src[ETH_ALEN];
 326         __be16   tvlv_len;
 327         uint16_t align;
 328 };
 329
 330 /**
 331  * struct batadv_tvlv_hdr - base tvlv header struct
 332  * @type: tvlv container type (see batadv_tvlv_type)
 333  * @version: tvlv container version
 334  * @len: tvlv container length
 335  */
 336 struct batadv_tvlv_hdr {
 337         uint8_t type;
 338         uint8_t version;
 339         __be16  len;
 340 };
 341
 342 /**
 343  * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
 344  *  container
 345  * @bandwidth_down: advertised uplink download bandwidth
 346  * @bandwidth_up: advertised uplink upload bandwidth
 347  */
 348 struct batadv_tvlv_gateway_data {
 349         __be32 bandwidth_down;
 350         __be32 bandwidth_up;
 351 };
 352
 353 /**
 354  * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
 355  * @flags: translation table flags (see batadv_tt_data_flags)
 356  * @ttvn: translation table version number
 357  * @reserved: field reserved for future use
 358  * @crc: crc32 checksum of the local translation table
 359  */
 360 struct batadv_tvlv_tt_data {
 361         uint8_t flags;
 362         uint8_t ttvn;
 363         uint16_t reserved;
 364         __be32  crc;
 365 };
 366
 367 /**
 368  * struct batadv_tvlv_tt_change - translation table diff data
 369  * @flags: status indicators concerning the non-mesh client (see
 370  *  batadv_tt_client_flags)
 371  * @reserved: reserved field
 372  * @addr: mac address of non-mesh client that triggered this tt change
 373  */
 374 struct batadv_tvlv_tt_change {
 375         uint8_t flags;
 376         uint8_t reserved;
 377         uint8_t addr[ETH_ALEN];
 378 };
 379
 380 /**
 381  * struct batadv_tvlv_roam_adv - roaming advertisement
 382  * @client: mac address of roaming client
 383  * @reserved: field reserved for future use
 384  */
 385 struct batadv_tvlv_roam_adv {
 386         uint8_t  client[ETH_ALEN];
 387         uint16_t reserved;
 388 };
 389
 390 #endif /* _NET_BATMAN_ADV_PACKET_H_ */