1 /* Copyright (C) 2007-2015 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, see <http://www.gnu.org/licenses/>. 16 */ 17 18 #ifndef _NET_BATMAN_ADV_PACKET_H_ 19 #define _NET_BATMAN_ADV_PACKET_H_ 20 21 #include <asm/byteorder.h> 22 #include <linux/types.h> 23 24 /** 25 * enum batadv_packettype - types for batman-adv encapsulated packets 26 * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV 27 * @BATADV_BCAST: broadcast packets carrying broadcast payload 28 * @BATADV_CODED: network coded packets 29 * 30 * @BATADV_UNICAST: unicast packets carrying unicast payload traffic 31 * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original 32 * payload packet 33 * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of 34 * the sender 35 * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute 36 * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers 37 */ 38 enum batadv_packettype { 39 /* 0x00 - 0x3f: local packets or special rules for handling */ 40 BATADV_IV_OGM = 0x00, 41 BATADV_BCAST = 0x01, 42 BATADV_CODED = 0x02, 43 /* 0x40 - 0x7f: unicast */ 44 #define BATADV_UNICAST_MIN 0x40 45 BATADV_UNICAST = 0x40, 46 BATADV_UNICAST_FRAG = 0x41, 47 BATADV_UNICAST_4ADDR = 0x42, 48 BATADV_ICMP = 0x43, 49 BATADV_UNICAST_TVLV = 0x44, 50 #define BATADV_UNICAST_MAX 0x7f 51 /* 0x80 - 0xff: reserved */ 52 }; 53 54 /** 55 * enum batadv_subtype - packet subtype for unicast4addr 56 * @BATADV_P_DATA: user payload 57 * @BATADV_P_DAT_DHT_GET: DHT request message 58 * @BATADV_P_DAT_DHT_PUT: DHT store message 59 * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT 60 */ 61 enum batadv_subtype { 62 BATADV_P_DATA = 0x01, 63 BATADV_P_DAT_DHT_GET = 0x02, 64 BATADV_P_DAT_DHT_PUT = 0x03, 65 BATADV_P_DAT_CACHE_REPLY = 0x04, 66 }; 67 68 /* this file is included by batctl which needs these defines */ 69 #define BATADV_COMPAT_VERSION 15 70 71 /** 72 * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets 73 * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was 74 * previously received from someone else than the best neighbor. 75 * @BATADV_PRIMARIES_FIRST_HOP: flag is set when the primary interface address 76 * is used, and the packet travels its first hop. 77 * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a 78 * one hop neighbor on the interface where it was originally received. 79 */ 80 enum batadv_iv_flags { 81 BATADV_NOT_BEST_NEXT_HOP = BIT(0), 82 BATADV_PRIMARIES_FIRST_HOP = BIT(1), 83 BATADV_DIRECTLINK = BIT(2), 84 }; 85 86 /* ICMP message types */ 87 enum batadv_icmp_packettype { 88 BATADV_ECHO_REPLY = 0, 89 BATADV_DESTINATION_UNREACHABLE = 3, 90 BATADV_ECHO_REQUEST = 8, 91 BATADV_TTL_EXCEEDED = 11, 92 BATADV_PARAMETER_PROBLEM = 12, 93 }; 94 95 /** 96 * enum batadv_mcast_flags - flags for multicast capabilities and settings 97 * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for 98 * 224.0.0.0/24 or ff02::1 99 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets 100 * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets 101 */ 102 enum batadv_mcast_flags { 103 BATADV_MCAST_WANT_ALL_UNSNOOPABLES = BIT(0), 104 BATADV_MCAST_WANT_ALL_IPV4 = BIT(1), 105 BATADV_MCAST_WANT_ALL_IPV6 = BIT(2), 106 }; 107 108 /* tt data subtypes */ 109 #define BATADV_TT_DATA_TYPE_MASK 0x0F 110 111 /** 112 * enum batadv_tt_data_flags - flags for tt data tvlv 113 * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM 114 * @BATADV_TT_REQUEST: TT request message 115 * @BATADV_TT_RESPONSE: TT response message 116 * @BATADV_TT_FULL_TABLE: contains full table to replace existing table 117 */ 118 enum batadv_tt_data_flags { 119 BATADV_TT_OGM_DIFF = BIT(0), 120 BATADV_TT_REQUEST = BIT(1), 121 BATADV_TT_RESPONSE = BIT(2), 122 BATADV_TT_FULL_TABLE = BIT(4), 123 }; 124 125 /** 126 * enum batadv_tt_client_flags - TT client specific flags 127 * @BATADV_TT_CLIENT_DEL: the client has to be deleted from the table 128 * @BATADV_TT_CLIENT_ROAM: the client roamed to/from another node and the new 129 * update telling its new real location has not been received/sent yet 130 * @BATADV_TT_CLIENT_WIFI: this client is connected through a wifi interface. 131 * This information is used by the "AP Isolation" feature 132 * @BATADV_TT_CLIENT_ISOLA: this client is considered "isolated". This 133 * information is used by the Extended Isolation feature 134 * @BATADV_TT_CLIENT_NOPURGE: this client should never be removed from the table 135 * @BATADV_TT_CLIENT_NEW: this client has been added to the local table but has 136 * not been announced yet 137 * @BATADV_TT_CLIENT_PENDING: this client is marked for removal but it is kept 138 * in the table for one more originator interval for consistency purposes 139 * @BATADV_TT_CLIENT_TEMP: this global client has been detected to be part of 140 * the network but no nnode has already announced it 141 * 142 * Bits from 0 to 7 are called _remote flags_ because they are sent on the wire. 143 * Bits from 8 to 15 are called _local flags_ because they are used for local 144 * computations only. 145 * 146 * Bits from 4 to 7 - a subset of remote flags - are ensured to be in sync with 147 * the other nodes in the network. To achieve this goal these flags are included 148 * in the TT CRC computation. 149 */ 150 enum batadv_tt_client_flags { 151 BATADV_TT_CLIENT_DEL = BIT(0), 152 BATADV_TT_CLIENT_ROAM = BIT(1), 153 BATADV_TT_CLIENT_WIFI = BIT(4), 154 BATADV_TT_CLIENT_ISOLA = BIT(5), 155 BATADV_TT_CLIENT_NOPURGE = BIT(8), 156 BATADV_TT_CLIENT_NEW = BIT(9), 157 BATADV_TT_CLIENT_PENDING = BIT(10), 158 BATADV_TT_CLIENT_TEMP = BIT(11), 159 }; 160 161 /** 162 * batadv_vlan_flags - flags for the four MSB of any vlan ID field 163 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not 164 */ 165 enum batadv_vlan_flags { 166 BATADV_VLAN_HAS_TAG = BIT(15), 167 }; 168 169 /* claim frame types for the bridge loop avoidance */ 170 enum batadv_bla_claimframe { 171 BATADV_CLAIM_TYPE_CLAIM = 0x00, 172 BATADV_CLAIM_TYPE_UNCLAIM = 0x01, 173 BATADV_CLAIM_TYPE_ANNOUNCE = 0x02, 174 BATADV_CLAIM_TYPE_REQUEST = 0x03, 175 }; 176 177 /** 178 * enum batadv_tvlv_type - tvlv type definitions 179 * @BATADV_TVLV_GW: gateway tvlv 180 * @BATADV_TVLV_DAT: distributed arp table tvlv 181 * @BATADV_TVLV_NC: network coding tvlv 182 * @BATADV_TVLV_TT: translation table tvlv 183 * @BATADV_TVLV_ROAM: roaming advertisement tvlv 184 * @BATADV_TVLV_MCAST: multicast capability tvlv 185 */ 186 enum batadv_tvlv_type { 187 BATADV_TVLV_GW = 0x01, 188 BATADV_TVLV_DAT = 0x02, 189 BATADV_TVLV_NC = 0x03, 190 BATADV_TVLV_TT = 0x04, 191 BATADV_TVLV_ROAM = 0x05, 192 BATADV_TVLV_MCAST = 0x06, 193 }; 194 195 #pragma pack(2) 196 /* the destination hardware field in the ARP frame is used to 197 * transport the claim type and the group id 198 */ 199 struct batadv_bla_claim_dst { 200 u8 magic[3]; /* FF:43:05 */ 201 u8 type; /* bla_claimframe */ 202 __be16 group; /* group id */ 203 }; 204 205 #pragma pack() 206 207 /** 208 * struct batadv_ogm_packet - ogm (routing protocol) packet 209 * @packet_type: batman-adv packet type, part of the general header 210 * @version: batman-adv protocol version, part of the genereal header 211 * @ttl: time to live for this packet, part of the genereal header 212 * @flags: contains routing relevant flags - see enum batadv_iv_flags 213 * @tvlv_len: length of tvlv data following the ogm header 214 */ 215 struct batadv_ogm_packet { 216 u8 packet_type; 217 u8 version; 218 u8 ttl; 219 u8 flags; 220 __be32 seqno; 221 u8 orig[ETH_ALEN]; 222 u8 prev_sender[ETH_ALEN]; 223 u8 reserved; 224 u8 tq; 225 __be16 tvlv_len; 226 /* __packed is not needed as the struct size is divisible by 4, 227 * and the largest data type in this struct has a size of 4. 228 */ 229 }; 230 231 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet) 232 233 /** 234 * batadv_icmp_header - common members among all the ICMP packets 235 * @packet_type: batman-adv packet type, part of the general header 236 * @version: batman-adv protocol version, part of the genereal header 237 * @ttl: time to live for this packet, part of the genereal header 238 * @msg_type: ICMP packet type 239 * @dst: address of the destination node 240 * @orig: address of the source node 241 * @uid: local ICMP socket identifier 242 * @align: not used - useful for alignment purposes only 243 * 244 * This structure is used for ICMP packets parsing only and it is never sent 245 * over the wire. The alignment field at the end is there to ensure that 246 * members are padded the same way as they are in real packets. 247 */ 248 struct batadv_icmp_header { 249 u8 packet_type; 250 u8 version; 251 u8 ttl; 252 u8 msg_type; /* see ICMP message types above */ 253 u8 dst[ETH_ALEN]; 254 u8 orig[ETH_ALEN]; 255 u8 uid; 256 u8 align[3]; 257 }; 258 259 /** 260 * batadv_icmp_packet - ICMP packet 261 * @packet_type: batman-adv packet type, part of the general header 262 * @version: batman-adv protocol version, part of the genereal header 263 * @ttl: time to live for this packet, part of the genereal header 264 * @msg_type: ICMP packet type 265 * @dst: address of the destination node 266 * @orig: address of the source node 267 * @uid: local ICMP socket identifier 268 * @reserved: not used - useful for alignment 269 * @seqno: ICMP sequence number 270 */ 271 struct batadv_icmp_packet { 272 u8 packet_type; 273 u8 version; 274 u8 ttl; 275 u8 msg_type; /* see ICMP message types above */ 276 u8 dst[ETH_ALEN]; 277 u8 orig[ETH_ALEN]; 278 u8 uid; 279 u8 reserved; 280 __be16 seqno; 281 }; 282 283 #define BATADV_RR_LEN 16 284 285 /** 286 * batadv_icmp_packet_rr - ICMP RouteRecord packet 287 * @packet_type: batman-adv packet type, part of the general header 288 * @version: batman-adv protocol version, part of the genereal header 289 * @ttl: time to live for this packet, part of the genereal header 290 * @msg_type: ICMP packet type 291 * @dst: address of the destination node 292 * @orig: address of the source node 293 * @uid: local ICMP socket identifier 294 * @rr_cur: number of entries the rr array 295 * @seqno: ICMP sequence number 296 * @rr: route record array 297 */ 298 struct batadv_icmp_packet_rr { 299 u8 packet_type; 300 u8 version; 301 u8 ttl; 302 u8 msg_type; /* see ICMP message types above */ 303 u8 dst[ETH_ALEN]; 304 u8 orig[ETH_ALEN]; 305 u8 uid; 306 u8 rr_cur; 307 __be16 seqno; 308 u8 rr[BATADV_RR_LEN][ETH_ALEN]; 309 }; 310 311 #define BATADV_ICMP_MAX_PACKET_SIZE sizeof(struct batadv_icmp_packet_rr) 312 313 /* All packet headers in front of an ethernet header have to be completely 314 * divisible by 2 but not by 4 to make the payload after the ethernet 315 * header again 4 bytes boundary aligned. 316 * 317 * A packing of 2 is necessary to avoid extra padding at the end of the struct 318 * caused by a structure member which is larger than two bytes. Otherwise 319 * the structure would not fulfill the previously mentioned rule to avoid the 320 * misalignment of the payload after the ethernet header. It may also lead to 321 * leakage of information when the padding it not initialized before sending. 322 */ 323 #pragma pack(2) 324 325 /** 326 * struct batadv_unicast_packet - unicast packet for network payload 327 * @packet_type: batman-adv packet type, part of the general header 328 * @version: batman-adv protocol version, part of the genereal header 329 * @ttl: time to live for this packet, part of the genereal header 330 * @ttvn: translation table version number 331 * @dest: originator destination of the unicast packet 332 */ 333 struct batadv_unicast_packet { 334 u8 packet_type; 335 u8 version; 336 u8 ttl; 337 u8 ttvn; /* destination translation table version number */ 338 u8 dest[ETH_ALEN]; 339 /* "4 bytes boundary + 2 bytes" long to make the payload after the 340 * following ethernet header again 4 bytes boundary aligned 341 */ 342 }; 343 344 /** 345 * struct batadv_unicast_4addr_packet - extended unicast packet 346 * @u: common unicast packet header 347 * @src: address of the source 348 * @subtype: packet subtype 349 */ 350 struct batadv_unicast_4addr_packet { 351 struct batadv_unicast_packet u; 352 u8 src[ETH_ALEN]; 353 u8 subtype; 354 u8 reserved; 355 /* "4 bytes boundary + 2 bytes" long to make the payload after the 356 * following ethernet header again 4 bytes boundary aligned 357 */ 358 }; 359 360 /** 361 * struct batadv_frag_packet - fragmented packet 362 * @packet_type: batman-adv packet type, part of the general header 363 * @version: batman-adv protocol version, part of the genereal header 364 * @ttl: time to live for this packet, part of the genereal header 365 * @dest: final destination used when routing fragments 366 * @orig: originator of the fragment used when merging the packet 367 * @no: fragment number within this sequence 368 * @reserved: reserved byte for alignment 369 * @seqno: sequence identification 370 * @total_size: size of the merged packet 371 */ 372 struct batadv_frag_packet { 373 u8 packet_type; 374 u8 version; /* batman version field */ 375 u8 ttl; 376 #if defined(__BIG_ENDIAN_BITFIELD) 377 u8 no:4; 378 u8 reserved:4; 379 #elif defined(__LITTLE_ENDIAN_BITFIELD) 380 u8 reserved:4; 381 u8 no:4; 382 #else 383 #error "unknown bitfield endianness" 384 #endif 385 u8 dest[ETH_ALEN]; 386 u8 orig[ETH_ALEN]; 387 __be16 seqno; 388 __be16 total_size; 389 }; 390 391 /** 392 * struct batadv_bcast_packet - broadcast packet for network payload 393 * @packet_type: batman-adv packet type, part of the general header 394 * @version: batman-adv protocol version, part of the genereal header 395 * @ttl: time to live for this packet, part of the genereal header 396 * @reserved: reserved byte for alignment 397 * @seqno: sequence identification 398 * @orig: originator of the broadcast packet 399 */ 400 struct batadv_bcast_packet { 401 u8 packet_type; 402 u8 version; /* batman version field */ 403 u8 ttl; 404 u8 reserved; 405 __be32 seqno; 406 u8 orig[ETH_ALEN]; 407 /* "4 bytes boundary + 2 bytes" long to make the payload after the 408 * following ethernet header again 4 bytes boundary aligned 409 */ 410 }; 411 412 /** 413 * struct batadv_coded_packet - network coded packet 414 * @packet_type: batman-adv packet type, part of the general header 415 * @version: batman-adv protocol version, part of the genereal header 416 * @ttl: time to live for this packet, part of the genereal header 417 * @reserved: Align following fields to 2-byte boundaries 418 * @first_source: original source of first included packet 419 * @first_orig_dest: original destinal of first included packet 420 * @first_crc: checksum of first included packet 421 * @first_ttvn: tt-version number of first included packet 422 * @second_ttl: ttl of second packet 423 * @second_dest: second receiver of this coded packet 424 * @second_source: original source of second included packet 425 * @second_orig_dest: original destination of second included packet 426 * @second_crc: checksum of second included packet 427 * @second_ttvn: tt version number of second included packet 428 * @coded_len: length of network coded part of the payload 429 */ 430 struct batadv_coded_packet { 431 u8 packet_type; 432 u8 version; /* batman version field */ 433 u8 ttl; 434 u8 first_ttvn; 435 /* u8 first_dest[ETH_ALEN]; - saved in mac header destination */ 436 u8 first_source[ETH_ALEN]; 437 u8 first_orig_dest[ETH_ALEN]; 438 __be32 first_crc; 439 u8 second_ttl; 440 u8 second_ttvn; 441 u8 second_dest[ETH_ALEN]; 442 u8 second_source[ETH_ALEN]; 443 u8 second_orig_dest[ETH_ALEN]; 444 __be32 second_crc; 445 __be16 coded_len; 446 }; 447 448 #pragma pack() 449 450 /** 451 * struct batadv_unicast_tvlv - generic unicast packet with tvlv payload 452 * @packet_type: batman-adv packet type, part of the general header 453 * @version: batman-adv protocol version, part of the genereal header 454 * @ttl: time to live for this packet, part of the genereal header 455 * @reserved: reserved field (for packet alignment) 456 * @src: address of the source 457 * @dst: address of the destination 458 * @tvlv_len: length of tvlv data following the unicast tvlv header 459 * @align: 2 bytes to align the header to a 4 byte boundary 460 */ 461 struct batadv_unicast_tvlv_packet { 462 u8 packet_type; 463 u8 version; /* batman version field */ 464 u8 ttl; 465 u8 reserved; 466 u8 dst[ETH_ALEN]; 467 u8 src[ETH_ALEN]; 468 __be16 tvlv_len; 469 u16 align; 470 }; 471 472 /** 473 * struct batadv_tvlv_hdr - base tvlv header struct 474 * @type: tvlv container type (see batadv_tvlv_type) 475 * @version: tvlv container version 476 * @len: tvlv container length 477 */ 478 struct batadv_tvlv_hdr { 479 u8 type; 480 u8 version; 481 __be16 len; 482 }; 483 484 /** 485 * struct batadv_tvlv_gateway_data - gateway data propagated through gw tvlv 486 * container 487 * @bandwidth_down: advertised uplink download bandwidth 488 * @bandwidth_up: advertised uplink upload bandwidth 489 */ 490 struct batadv_tvlv_gateway_data { 491 __be32 bandwidth_down; 492 __be32 bandwidth_up; 493 }; 494 495 /** 496 * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container 497 * @flags: translation table flags (see batadv_tt_data_flags) 498 * @ttvn: translation table version number 499 * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by 500 * one batadv_tvlv_tt_vlan_data object per announced vlan 501 */ 502 struct batadv_tvlv_tt_data { 503 u8 flags; 504 u8 ttvn; 505 __be16 num_vlan; 506 }; 507 508 /** 509 * struct batadv_tvlv_tt_vlan_data - vlan specific tt data propagated through 510 * the tt tvlv container 511 * @crc: crc32 checksum of the entries belonging to this vlan 512 * @vid: vlan identifier 513 * @reserved: unused, useful for alignment purposes 514 */ 515 struct batadv_tvlv_tt_vlan_data { 516 __be32 crc; 517 __be16 vid; 518 u16 reserved; 519 }; 520 521 /** 522 * struct batadv_tvlv_tt_change - translation table diff data 523 * @flags: status indicators concerning the non-mesh client (see 524 * batadv_tt_client_flags) 525 * @reserved: reserved field - useful for alignment purposes only 526 * @addr: mac address of non-mesh client that triggered this tt change 527 * @vid: VLAN identifier 528 */ 529 struct batadv_tvlv_tt_change { 530 u8 flags; 531 u8 reserved[3]; 532 u8 addr[ETH_ALEN]; 533 __be16 vid; 534 }; 535 536 /** 537 * struct batadv_tvlv_roam_adv - roaming advertisement 538 * @client: mac address of roaming client 539 * @vid: VLAN identifier 540 */ 541 struct batadv_tvlv_roam_adv { 542 u8 client[ETH_ALEN]; 543 __be16 vid; 544 }; 545 546 /** 547 * struct batadv_tvlv_mcast_data - payload of a multicast tvlv 548 * @flags: multicast flags announced by the orig node 549 * @reserved: reserved field 550 */ 551 struct batadv_tvlv_mcast_data { 552 u8 flags; 553 u8 reserved[3]; 554 }; 555 556 #endif /* _NET_BATMAN_ADV_PACKET_H_ */ 557