net/batman-adv/packet.h

   1 /* Copyright (C) 2007-2012 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 #define BATADV_ETH_P_BATMAN  0x4305 /* unofficial/not registered Ethertype */
  24
  25 enum batadv_packettype {
  26         BATADV_IV_OGM           = 0x01,
  27         BATADV_ICMP             = 0x02,
  28         BATADV_UNICAST          = 0x03,
  29         BATADV_BCAST            = 0x04,
  30         BATADV_VIS              = 0x05,
  31         BATADV_UNICAST_FRAG     = 0x06,
  32         BATADV_TT_QUERY         = 0x07,
  33         BATADV_ROAM_ADV         = 0x08,
  34         BATADV_UNICAST_4ADDR    = 0x09,
  35 };
  36
  37 /**
  38  * enum batadv_subtype - packet subtype for unicast4addr
  39  * @BATADV_P_DATA: user payload
  40  * @BATADV_P_DAT_DHT_GET: DHT request message
  41  * @BATADV_P_DAT_DHT_PUT: DHT store message
  42  * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT
  43  */
  44 enum batadv_subtype {
  45         BATADV_P_DATA                   = 0x01,
  46         BATADV_P_DAT_DHT_GET            = 0x02,
  47         BATADV_P_DAT_DHT_PUT            = 0x03,
  48         BATADV_P_DAT_CACHE_REPLY        = 0x04,
  49 };
  50
  51 /* this file is included by batctl which needs these defines */
  52 #define BATADV_COMPAT_VERSION 14
  53
  54 enum batadv_iv_flags {
  55         BATADV_NOT_BEST_NEXT_HOP   = BIT(3),
  56         BATADV_PRIMARIES_FIRST_HOP = BIT(4),
  57         BATADV_VIS_SERVER          = BIT(5),
  58         BATADV_DIRECTLINK          = BIT(6),
  59 };
  60
  61 /* ICMP message types */
  62 enum batadv_icmp_packettype {
  63         BATADV_ECHO_REPLY              = 0,
  64         BATADV_DESTINATION_UNREACHABLE = 3,
  65         BATADV_ECHO_REQUEST            = 8,
  66         BATADV_TTL_EXCEEDED            = 11,
  67         BATADV_PARAMETER_PROBLEM       = 12,
  68 };
  69
  70 /* vis defines */
  71 enum batadv_vis_packettype {
  72         BATADV_VIS_TYPE_SERVER_SYNC   = 0,
  73         BATADV_VIS_TYPE_CLIENT_UPDATE = 1,
  74 };
  75
  76 /* fragmentation defines */
  77 enum batadv_unicast_frag_flags {
  78         BATADV_UNI_FRAG_HEAD      = BIT(0),
  79         BATADV_UNI_FRAG_LARGETAIL = BIT(1),
  80 };
  81
  82 /* TT_QUERY subtypes */
  83 #define BATADV_TT_QUERY_TYPE_MASK 0x3
  84
  85 enum batadv_tt_query_packettype {
  86         BATADV_TT_REQUEST  = 0,
  87         BATADV_TT_RESPONSE = 1,
  88 };
  89
  90 /* TT_QUERY flags */
  91 enum batadv_tt_query_flags {
  92         BATADV_TT_FULL_TABLE = BIT(2),
  93 };
  94
  95 /* BATADV_TT_CLIENT flags.
  96  * Flags from BIT(0) to BIT(7) are sent on the wire, while flags from BIT(8) to
  97  * BIT(15) are used for local computation only
  98  */
  99 enum batadv_tt_client_flags {
 100         BATADV_TT_CLIENT_DEL     = BIT(0),
 101         BATADV_TT_CLIENT_ROAM    = BIT(1),
 102         BATADV_TT_CLIENT_WIFI    = BIT(2),
 103         BATADV_TT_CLIENT_TEMP    = BIT(3),
 104         BATADV_TT_CLIENT_NOPURGE = BIT(8),
 105         BATADV_TT_CLIENT_NEW     = BIT(9),
 106         BATADV_TT_CLIENT_PENDING = BIT(10),
 107 };
 108
 109 /* claim frame types for the bridge loop avoidance */
 110 enum batadv_bla_claimframe {
 111         BATADV_CLAIM_TYPE_CLAIM         = 0x00,
 112         BATADV_CLAIM_TYPE_UNCLAIM       = 0x01,
 113         BATADV_CLAIM_TYPE_ANNOUNCE      = 0x02,
 114         BATADV_CLAIM_TYPE_REQUEST       = 0x03,
 115 };
 116
 117 /* the destination hardware field in the ARP frame is used to
 118  * transport the claim type and the group id
 119  */
 120 struct batadv_bla_claim_dst {
 121         uint8_t magic[3];       /* FF:43:05 */
 122         uint8_t type;           /* bla_claimframe */
 123         __be16 group;           /* group id */
 124 };
 125
 126 struct batadv_header {
 127         uint8_t  packet_type;
 128         uint8_t  version;  /* batman version field */
 129         uint8_t  ttl;
 130         /* the parent struct has to add a byte after the header to make
 131          * everything 4 bytes aligned again
 132          */
 133 };
 134
 135 struct batadv_ogm_packet {
 136         struct batadv_header header;
 137         uint8_t  flags;    /* 0x40: DIRECTLINK flag, 0x20 VIS_SERVER flag... */
 138         __be32   seqno;
 139         uint8_t  orig[ETH_ALEN];
 140         uint8_t  prev_sender[ETH_ALEN];
 141         uint8_t  gw_flags;  /* flags related to gateway class */
 142         uint8_t  tq;
 143         uint8_t  tt_num_changes;
 144         uint8_t  ttvn; /* translation table version number */
 145         __be16   tt_crc;
 146 } __packed;
 147
 148 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
 149
 150 struct batadv_icmp_packet {
 151         struct batadv_header header;
 152         uint8_t  msg_type; /* see ICMP message types above */
 153         uint8_t  dst[ETH_ALEN];
 154         uint8_t  orig[ETH_ALEN];
 155         __be16   seqno;
 156         uint8_t  uid;
 157         uint8_t  reserved;
 158 };
 159
 160 #define BATADV_RR_LEN 16
 161
 162 /* icmp_packet_rr must start with all fields from imcp_packet
 163  * as this is assumed by code that handles ICMP packets
 164  */
 165 struct batadv_icmp_packet_rr {
 166         struct batadv_header header;
 167         uint8_t  msg_type; /* see ICMP message types above */
 168         uint8_t  dst[ETH_ALEN];
 169         uint8_t  orig[ETH_ALEN];
 170         __be16   seqno;
 171         uint8_t  uid;
 172         uint8_t  rr_cur;
 173         uint8_t  rr[BATADV_RR_LEN][ETH_ALEN];
 174 };
 175
 176 /* All packet headers in front of an ethernet header have to be completely
 177  * divisible by 2 but not by 4 to make the payload after the ethernet
 178  * header again 4 bytes boundary aligned.
 179  *
 180  * A packing of 2 is necessary to avoid extra padding at the end of the struct
 181  * caused by a structure member which is larger than two bytes. Otherwise
 182  * the structure would not fulfill the previously mentioned rule to avoid the
 183  * misalignment of the payload after the ethernet header. It may also lead to
 184  * leakage of information when the padding it not initialized before sending.
 185  */
 186 #pragma pack(2)
 187
 188 struct batadv_unicast_packet {
 189         struct batadv_header header;
 190         uint8_t  ttvn; /* destination translation table version number */
 191         uint8_t  dest[ETH_ALEN];
 192         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 193          * following ethernet header again 4 bytes boundary aligned
 194          */
 195 };
 196
 197 /**
 198  * struct batadv_unicast_4addr_packet - extended unicast packet
 199  * @u: common unicast packet header
 200  * @src: address of the source
 201  * @subtype: packet subtype
 202  */
 203 struct batadv_unicast_4addr_packet {
 204         struct batadv_unicast_packet u;
 205         uint8_t src[ETH_ALEN];
 206         uint8_t subtype;
 207         uint8_t reserved;
 208         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 209          * following ethernet header again 4 bytes boundary aligned
 210          */
 211 };
 212
 213 struct batadv_unicast_frag_packet {
 214         struct batadv_header header;
 215         uint8_t  ttvn; /* destination translation table version number */
 216         uint8_t  dest[ETH_ALEN];
 217         uint8_t  flags;
 218         uint8_t  align;
 219         uint8_t  orig[ETH_ALEN];
 220         __be16   seqno;
 221 } __packed;
 222
 223 struct batadv_bcast_packet {
 224         struct batadv_header header;
 225         uint8_t  reserved;
 226         __be32   seqno;
 227         uint8_t  orig[ETH_ALEN];
 228         /* "4 bytes boundary + 2 bytes" long to make the payload after the
 229          * following ethernet header again 4 bytes boundary aligned
 230          */
 231 };
 232
 233 #pragma pack()
 234
 235 struct batadv_vis_packet {
 236         struct batadv_header header;
 237         uint8_t  vis_type;       /* which type of vis-participant sent this? */
 238         __be32   seqno;          /* sequence number */
 239         uint8_t  entries;        /* number of entries behind this struct */
 240         uint8_t  reserved;
 241         uint8_t  vis_orig[ETH_ALEN];    /* originator reporting its neighbors */
 242         uint8_t  target_orig[ETH_ALEN]; /* who should receive this packet */
 243         uint8_t  sender_orig[ETH_ALEN]; /* who sent or forwarded this packet */
 244 };
 245
 246 struct batadv_tt_query_packet {
 247         struct batadv_header header;
 248         /* the flag field is a combination of:
 249          * - TT_REQUEST or TT_RESPONSE
 250          * - TT_FULL_TABLE
 251          */
 252         uint8_t  flags;
 253         uint8_t  dst[ETH_ALEN];
 254         uint8_t  src[ETH_ALEN];
 255         /* the ttvn field is:
 256          * if TT_REQUEST: ttvn that triggered the
 257          *                request
 258          * if TT_RESPONSE: new ttvn for the src
 259          *                 orig_node
 260          */
 261         uint8_t  ttvn;
 262         /* tt_data field is:
 263          * if TT_REQUEST: crc associated with the
 264          *                ttvn
 265          * if TT_RESPONSE: table_size
 266          */
 267         __be16 tt_data;
 268 } __packed;
 269
 270 struct batadv_roam_adv_packet {
 271         struct batadv_header header;
 272         uint8_t  reserved;
 273         uint8_t  dst[ETH_ALEN];
 274         uint8_t  src[ETH_ALEN];
 275         uint8_t  client[ETH_ALEN];
 276 } __packed;
 277
 278 struct batadv_tt_change {
 279         uint8_t flags;
 280         uint8_t addr[ETH_ALEN];
 281 } __packed;
 282
 283 #endif /* _NET_BATMAN_ADV_PACKET_H_ */