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