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_UNICAST_TVLV: unicast packet carrying TVLV containers
  26  */
  27 enum batadv_packettype {
  28         BATADV_IV_OGM           = 0x01,
  29         BATADV_ICMP             = 0x02,
  30         BATADV_UNICAST          = 0x03,
  31         BATADV_BCAST            = 0x04,
  32         BATADV_VIS              = 0x05,
  33         BATADV_UNICAST_FRAG     = 0x06,
  34         BATADV_UNICAST_4ADDR    = 0x09,
  35         BATADV_CODED            = 0x0a,
  36         BATADV_UNICAST_TVLV     = 0x0b,
  37 };
  38
  39 /**
  40  * enum batadv_subtype - packet subtype for unicast4addr
  41  * @BATADV_P_DATA: user payload
  42  * @BATADV_P_DAT_DHT_GET: DHT request message
  43  * @BATADV_P_DAT_DHT_PUT: DHT store message
  44  * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
  45  */
  46 enum batadv_subtype {
  47         BATADV_P_DATA                   = 0x01,
  48         BATADV_P_DAT_DHT_GET            = 0x02,
  49         BATADV_P_DAT_DHT_PUT            = 0x03,
  50         BATADV_P_DAT_CACHE_REPLY        = 0x04,
  51 };
  52
  53 /* this file is included by batctl which needs these defines */
  54 #define BATADV_COMPAT_VERSION 15
  55
  56 enum batadv_iv_flags {
  57         BATADV_NOT_BEST_NEXT_HOP   = BIT(3),
  58         BATADV_PRIMARIES_FIRST_HOP = BIT(4),
  59         BATADV_VIS_SERVER          = BIT(5),
  60         BATADV_DIRECTLINK          = BIT(6),
  61 };
  62
  63 /* ICMP message types */
  64 enum batadv_icmp_packettype {
  65         BATADV_ECHO_REPLY              = 0,
  66         BATADV_DESTINATION_UNREACHABLE = 3,
  67         BATADV_ECHO_REQUEST            = 8,
  68         BATADV_TTL_EXCEEDED            = 11,
  69         BATADV_PARAMETER_PROBLEM       = 12,
  70 };
  71
  72 /* vis defines */
  73 enum batadv_vis_packettype {
  74         BATADV_VIS_TYPE_SERVER_SYNC   = 0,
  75         BATADV_VIS_TYPE_CLIENT_UPDATE = 1,
  76 };
  77
  78 /* fragmentation defines */
  79 enum batadv_unicast_frag_flags {
  80         BATADV_UNI_FRAG_HEAD      = BIT(0),
  81         BATADV_UNI_FRAG_LARGETAIL = BIT(1),
  82 };
  83
  84 /* tt data subtypes */
  85 #define BATADV_TT_DATA_TYPE_MASK 0x0F
  86
  87 /**
  88  * enum batadv_tt_data_flags - flags for tt data tvlv
  89  * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM
  90  * @BATADV_TT_REQUEST: TT request message
  91  * @BATADV_TT_RESPONSE: TT response message
  92  * @BATADV_TT_FULL_TABLE: contains full table to replace existing table
  93  */
  94 enum batadv_tt_data_flags {
  95         BATADV_TT_OGM_DIFF   = BIT(0),
  96         BATADV_TT_REQUEST    = BIT(1),
  97         BATADV_TT_RESPONSE   = BIT(2),
  98         BATADV_TT_FULL_TABLE = BIT(4),
  99 };
 100
 101 /* BATADV_TT_CLIENT flags.
 102  * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
 103  * BIT(15) are used for local computation only
 104  */
 105 enum batadv_tt_client_flags {
 106         BATADV_TT_CLIENT_DEL     = BIT(0),
 107         BATADV_TT_CLIENT_ROAM    = BIT(1),
 108         BATADV_TT_CLIENT_WIFI    = BIT(2),
 109         BATADV_TT_CLIENT_TEMP    = BIT(3),
 110         BATADV_TT_CLIENT_NOPURGE = BIT(8),
 111         BATADV_TT_CLIENT_NEW     = BIT(9),
 112         BATADV_TT_CLIENT_PENDING = BIT(10),
 113 };
 114
 115 /* claim frame types for the bridge loop avoidance */
 116 enum batadv_bla_claimframe {
 117         BATADV_CLAIM_TYPE_CLAIM         = 0x00,
 118         BATADV_CLAIM_TYPE_UNCLAIM       = 0x01,
 119         BATADV_CLAIM_TYPE_ANNOUNCE      = 0x02,
 120         BATADV_CLAIM_TYPE_REQUEST       = 0x03,
 121 };
 122
 123 /**
 124  * enum batadv_tvlv_type - tvlv type definitions
 125  * @BATADV_TVLV_GW: gateway tvlv
 126  * @BATADV_TVLV_DAT: distributed arp table tvlv
 127  * @BATADV_TVLV_NC: network coding tvlv
 128  * @BATADV_TVLV_TT: translation table tvlv
 129  * @BATADV_TVLV_ROAM: roaming advertisement tvlv
 130  */
 131 enum batadv_tvlv_type {
 132         BATADV_TVLV_GW          = 0x01,
 133         BATADV_TVLV_DAT         = 0x02,
 134         BATADV_TVLV_NC          = 0x03,
 135         BATADV_TVLV_TT          = 0x04,
 136         BATADV_TVLV_ROAM        = 0x05,
 137 };
 138
 139 /* the destination hardware field in the ARP frame is used to
 140  * transport the claim type and the group id
 141  */
 142 struct batadv_bla_claim_dst {
 143         uint8_t magic[3];       /* FF:43:05 */
 144         uint8_t type;           /* bla_claimframe */
 145         __be16 group;           /* group id */
 146 };
 147
 148 struct batadv_header {
 149         uint8_t  packet_type;
 150         uint8_t  version;  /* batman version field */
 151         uint8_t  ttl;
 152         /* the parent struct has to add a byte after the header to make
 153          * everything 4 bytes aligned again
 154          */
 155 };
 156
 157 /**
 158  * struct batadv_ogm_packet - ogm (routing protocol) packet
 159  * @header: common batman packet header
 160  * @tvlv_len: length of tvlv data following the ogm header
 161  */
 162 struct batadv_ogm_packet {
 163         struct batadv_header header;
 164         uint8_t  flags;    /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
 165         __be32   seqno;
 166         uint8_t  orig[ETH_ALEN];
 167         uint8_t  prev_sender[ETH_ALEN];
 168         uint8_t  reserved;
 169         uint8_t  tq;
 170         __be16   tvlv_len;
 171 } __packed;
 172
 173 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
 174
 175 struct batadv_icmp_packet {
 176         struct batadv_header header;
 177         uint8_t  msg_type; /* see ICMP message types above */
 178         uint8_t  dst[ETH_ALEN];
 179         uint8_t  orig[ETH_ALEN];
 180         __be16   seqno;
 181         uint8_t  uid;
 182         uint8_t  reserved;
 183 };
 184
 185 #define BATADV_RR_LEN 16
 186
 187 /* icmp_packet_rr must start with all fields from imcp_packet
 188  * as this is assumed by code that handles ICMP packets
 189  */
 190 struct batadv_icmp_packet_rr {
 191         struct batadv_header header;
 192         uint8_t  msg_type; /* see ICMP message types above */
 193         uint8_t  dst[ETH_ALEN];
 194         uint8_t  orig[ETH_ALEN];
 195         __be16   seqno;
 196         uint8_t  uid;
 197         uint8_t  rr_cur;
 198         uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
 199 };
 200
 201 /* All packet headers in front of an ethernet header have to be completely
 202  * divisible by 2 but not by 4 to make the payload after the ethernet
 203  * header again 4 bytes boundary aligned.
 204  *
 205  * A packing of 2 is necessary to avoid extra padding at the end of the struct
 206  * caused by a structure member which is larger than two bytes. Otherwise
 207  * the structure would not fulfill the previously mentioned rule to avoid the
 208  * misalignment of the payload after the ethernet header. It may also lead to
 209  * leakage of information when the padding it not initialized before sending.
 210  */
 211 #pragma pack(2)
 212
 213 struct batadv_unicast_packet {
 214         struct batadv_header header;
 215         uint8_t  ttvn; /* destination translation table version number */
 216         uint8_t  dest[ETH_ALEN];
 217         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 218          * following ethernet header again 4 bytes boundary aligned
 219          */
 220 };
 221
 222 /**
 223  * struct batadv_unicast_4addr_packet - extended unicast packet
 224  * @u: common unicast packet header
 225  * @src: address of the source
 226  * @subtype: packet subtype
 227  */
 228 struct batadv_unicast_4addr_packet {
 229         struct batadv_unicast_packet u;
 230         uint8_t src[ETH_ALEN];
 231         uint8_t subtype;
 232         uint8_t reserved;
 233         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 234          * following ethernet header again 4 bytes boundary aligned
 235          */
 236 };
 237
 238 struct batadv_unicast_frag_packet {
 239         struct batadv_header header;
 240         uint8_t  ttvn; /* destination translation table version number */
 241         uint8_t  dest[ETH_ALEN];
 242         uint8_t  flags;
 243         uint8_t  align;
 244         uint8_t  orig[ETH_ALEN];
 245         __be16   seqno;
 246 } __packed;
 247
 248 struct batadv_bcast_packet {
 249         struct batadv_header header;
 250         uint8_t  reserved;
 251         __be32   seqno;
 252         uint8_t  orig[ETH_ALEN];
 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 #pragma pack()
 259
 260 struct batadv_vis_packet {
 261         struct batadv_header header;
 262         uint8_t  vis_type;       /* which type of vis-participant sent this? */
 263         __be32   seqno;          /* sequence number */
 264         uint8_t  entries;        /* number of entries behind this struct */
 265         uint8_t  reserved;
 266         uint8_t  vis_orig[ETH_ALEN];    /* originator reporting its neighbors */
 267         uint8_t  target_orig[ETH_ALEN]; /* who should receive this packet */
 268         uint8_t  sender_orig[ETH_ALEN]; /* who sent or forwarded this packet */
 269 };
 270
 271 /**
 272  * struct batadv_coded_packet - network coded packet
 273  * @header: common batman packet header and ttl of first included packet
 274  * @reserved: Align following fields to 2-byte boundaries
 275  * @first_source: original source of first included packet
 276  * @first_orig_dest: original destinal of first included packet
 277  * @first_crc: checksum of first included packet
 278  * @first_ttvn: tt-version number of first included packet
 279  * @second_ttl: ttl of second packet
 280  * @second_dest: second receiver of this coded packet
 281  * @second_source: original source of second included packet
 282  * @second_orig_dest: original destination of second included packet
 283  * @second_crc: checksum of second included packet
 284  * @second_ttvn: tt version number of second included packet
 285  * @coded_len: length of network coded part of the payload
 286  */
 287 struct batadv_coded_packet {
 288         struct batadv_header header;
 289         uint8_t  first_ttvn;
 290         /* uint8_t  first_dest[ETH_ALEN]; - saved in mac header destination */
 291         uint8_t  first_source[ETH_ALEN];
 292         uint8_t  first_orig_dest[ETH_ALEN];
 293         __be32   first_crc;
 294         uint8_t  second_ttl;
 295         uint8_t  second_ttvn;
 296         uint8_t  second_dest[ETH_ALEN];
 297         uint8_t  second_source[ETH_ALEN];
 298         uint8_t  second_orig_dest[ETH_ALEN];
 299         __be32   second_crc;
 300         __be16   coded_len;
 301 };
 302
 303 /**
 304  * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload
 305  * @header: common batman packet header
 306  * @reserved: reserved field (for packet alignment)
 307  * @src: address of the source
 308  * @dst: address of the destination
 309  * @tvlv_len: length of tvlv data following the unicast tvlv header
 310  * @align: 2 bytes to align the header to a 4 byte boundry
 311  */
 312 struct batadv_unicast_tvlv_packet {
 313         struct batadv_header header;
 314         uint8_t  reserved;
 315         uint8_t  dst[ETH_ALEN];
 316         uint8_t  src[ETH_ALEN];
 317         __be16   tvlv_len;
 318         uint16_t align;
 319 };
 320
 321 /**
 322  * struct batadv_tvlv_hdr - base tvlv header struct
 323  * @type: tvlv container type (see batadv_tvlv_type)
 324  * @version: tvlv container version
 325  * @len: tvlv container length
 326  */
 327 struct batadv_tvlv_hdr {
 328         uint8_t type;
 329         uint8_t version;
 330         __be16  len;
 331 };
 332
 333 /**
 334  * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv
 335  *  container
 336  * @bandwidth_down: advertised uplink download bandwidth
 337  * @bandwidth_up: advertised uplink upload bandwidth
 338  */
 339 struct batadv_tvlv_gateway_data {
 340         __be32 bandwidth_down;
 341         __be32 bandwidth_up;
 342 };
 343
 344 /**
 345  * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
 346  * @flags: translation table flags (see batadv_tt_data_flags)
 347  * @ttvn: translation table version number
 348  * @crc: crc16 checksum of the local translation table
 349  */
 350 struct batadv_tvlv_tt_data {
 351         uint8_t flags;
 352         uint8_t ttvn;
 353         __be16  crc;
 354 };
 355
 356 /**
 357  * struct batadv_tvlv_tt_change - translation table diff data
 358  * @flags: status indicators concerning the non-mesh client (see
 359  *  batadv_tt_client_flags)
 360  * @reserved: reserved field
 361  * @addr: mac address of non-mesh client that triggered this tt change
 362  */
 363 struct batadv_tvlv_tt_change {
 364         uint8_t flags;
 365         uint8_t reserved;
 366         uint8_t addr[ETH_ALEN];
 367 };
 368
 369 /**
 370  * struct batadv_tvlv_roam_adv - roaming advertisement
 371  * @client: mac address of roaming client
 372  * @reserved: field reserved for future use
 373  */
 374 struct batadv_tvlv_roam_adv {
 375         uint8_t  client[ETH_ALEN];
 376         uint16_t reserved;
 377 };
 378
 379 #endif /* _NET_BATMAN_ADV_PACKET_H_ */