631 lines · 19.9 KB · C
RawDownload
/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) *//* Copyright (C) 2007-2020  B.A.T.M.A.N. contributors: * * Marek Lindner, Simon Wunderlich */ #ifndef _UAPI_LINUX_BATADV_PACKET_H_#define _UAPI_LINUX_BATADV_PACKET_H_ #include <asm/byteorder.h>#include <linux/if_ether.h>#include <linux/types.h> /** * batadv_tp_is_error() - Check throughput meter return code for error * @n: throughput meter return code * * Return: 0 when not error was detected, != 0 otherwise */#define batadv_tp_is_error(n) ((__u8)(n) > 127 ? 1 : 0) /** * enum batadv_packettype - types for batman-adv encapsulated packets * @BATADV_IV_OGM: originator messages for B.A.T.M.A.N. IV * @BATADV_BCAST: broadcast packets carrying broadcast payload * @BATADV_CODED: network coded packets * @BATADV_ELP: echo location packets for B.A.T.M.A.N. V * @BATADV_OGM2: originator messages for B.A.T.M.A.N. V * * @BATADV_UNICAST: unicast packets carrying unicast payload traffic * @BATADV_UNICAST_FRAG: unicast packets carrying a fragment of the original *     payload packet * @BATADV_UNICAST_4ADDR: unicast packet including the originator address of *     the sender * @BATADV_ICMP: unicast packet like IP ICMP used for ping or traceroute * @BATADV_UNICAST_TVLV: unicast packet carrying TVLV containers */enum batadv_packettype {	/* 0x00 - 0x3f: local packets or special rules for handling */	BATADV_IV_OGM           = 0x00,	BATADV_BCAST            = 0x01,	BATADV_CODED            = 0x02,	BATADV_ELP		= 0x03,	BATADV_OGM2		= 0x04,	/* 0x40 - 0x7f: unicast */#define BATADV_UNICAST_MIN     0x40	BATADV_UNICAST          = 0x40,	BATADV_UNICAST_FRAG     = 0x41,	BATADV_UNICAST_4ADDR    = 0x42,	BATADV_ICMP             = 0x43,	BATADV_UNICAST_TVLV     = 0x44,#define BATADV_UNICAST_MAX     0x7f	/* 0x80 - 0xff: reserved */}; /** * enum batadv_subtype - packet subtype for unicast4addr * @BATADV_P_DATA: user payload * @BATADV_P_DAT_DHT_GET: DHT request message * @BATADV_P_DAT_DHT_PUT: DHT store message * @BATADV_P_DAT_CACHE_REPLY: ARP reply generated by DAT */enum batadv_subtype {	BATADV_P_DATA			= 0x01,	BATADV_P_DAT_DHT_GET		= 0x02,	BATADV_P_DAT_DHT_PUT		= 0x03,	BATADV_P_DAT_CACHE_REPLY	= 0x04,}; /* this file is included by batctl which needs these defines */#define BATADV_COMPAT_VERSION 15 /** * enum batadv_iv_flags - flags used in B.A.T.M.A.N. IV OGM packets * @BATADV_NOT_BEST_NEXT_HOP: flag is set when ogm packet is forwarded and was *     previously received from someone else than the best neighbor. * @BATADV_PRIMARIES_FIRST_HOP: flag unused. * @BATADV_DIRECTLINK: flag is for the first hop or if rebroadcasted from a *     one hop neighbor on the interface where it was originally received. */enum batadv_iv_flags {	BATADV_NOT_BEST_NEXT_HOP   = 1UL << 0,	BATADV_PRIMARIES_FIRST_HOP = 1UL << 1,	BATADV_DIRECTLINK          = 1UL << 2,}; /** * enum batadv_icmp_packettype - ICMP message types * @BATADV_ECHO_REPLY: success reply to BATADV_ECHO_REQUEST * @BATADV_DESTINATION_UNREACHABLE: failure when route to destination not found * @BATADV_ECHO_REQUEST: request BATADV_ECHO_REPLY from destination * @BATADV_TTL_EXCEEDED: error after BATADV_ECHO_REQUEST traversed too many hops * @BATADV_PARAMETER_PROBLEM: return code for malformed messages * @BATADV_TP: throughput meter packet */enum batadv_icmp_packettype {	BATADV_ECHO_REPLY	       = 0,	BATADV_DESTINATION_UNREACHABLE = 3,	BATADV_ECHO_REQUEST	       = 8,	BATADV_TTL_EXCEEDED	       = 11,	BATADV_PARAMETER_PROBLEM       = 12,	BATADV_TP		       = 15,}; /** * enum batadv_mcast_flags - flags for multicast capabilities and settings * @BATADV_MCAST_WANT_ALL_UNSNOOPABLES: we want all packets destined for *  224.0.0.0/24 or ff02::1 * @BATADV_MCAST_WANT_ALL_IPV4: we want all IPv4 multicast packets *  (both link-local and routable ones) * @BATADV_MCAST_WANT_ALL_IPV6: we want all IPv6 multicast packets *  (both link-local and routable ones) * @BATADV_MCAST_WANT_NO_RTR4: we have no IPv4 multicast router and therefore * only need routable IPv4 multicast packets we signed up for explicitly * @BATADV_MCAST_WANT_NO_RTR6: we have no IPv6 multicast router and therefore * only need routable IPv6 multicast packets we signed up for explicitly */enum batadv_mcast_flags {	BATADV_MCAST_WANT_ALL_UNSNOOPABLES	= 1UL << 0,	BATADV_MCAST_WANT_ALL_IPV4		= 1UL << 1,	BATADV_MCAST_WANT_ALL_IPV6		= 1UL << 2,	BATADV_MCAST_WANT_NO_RTR4		= 1UL << 3,	BATADV_MCAST_WANT_NO_RTR6		= 1UL << 4,}; /* tt data subtypes */#define BATADV_TT_DATA_TYPE_MASK 0x0F /** * enum batadv_tt_data_flags - flags for tt data tvlv * @BATADV_TT_OGM_DIFF: TT diff propagated through OGM * @BATADV_TT_REQUEST: TT request message * @BATADV_TT_RESPONSE: TT response message * @BATADV_TT_FULL_TABLE: contains full table to replace existing table */enum batadv_tt_data_flags {	BATADV_TT_OGM_DIFF   = 1UL << 0,	BATADV_TT_REQUEST    = 1UL << 1,	BATADV_TT_RESPONSE   = 1UL << 2,	BATADV_TT_FULL_TABLE = 1UL << 4,}; /** * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not */enum batadv_vlan_flags {	BATADV_VLAN_HAS_TAG	= 1UL << 15,}; /** * enum batadv_bla_claimframe - claim frame types for the bridge loop avoidance * @BATADV_CLAIM_TYPE_CLAIM: claim of a client mac address * @BATADV_CLAIM_TYPE_UNCLAIM: unclaim of a client mac address * @BATADV_CLAIM_TYPE_ANNOUNCE: announcement of backbone with current crc * @BATADV_CLAIM_TYPE_REQUEST: request of full claim table * @BATADV_CLAIM_TYPE_LOOPDETECT: mesh-traversing loop detect packet */enum batadv_bla_claimframe {	BATADV_CLAIM_TYPE_CLAIM		= 0x00,	BATADV_CLAIM_TYPE_UNCLAIM	= 0x01,	BATADV_CLAIM_TYPE_ANNOUNCE	= 0x02,	BATADV_CLAIM_TYPE_REQUEST	= 0x03,	BATADV_CLAIM_TYPE_LOOPDETECT	= 0x04,}; /** * enum batadv_tvlv_type - tvlv type definitions * @BATADV_TVLV_GW: gateway tvlv * @BATADV_TVLV_DAT: distributed arp table tvlv * @BATADV_TVLV_NC: network coding tvlv * @BATADV_TVLV_TT: translation table tvlv * @BATADV_TVLV_ROAM: roaming advertisement tvlv * @BATADV_TVLV_MCAST: multicast capability tvlv */enum batadv_tvlv_type {	BATADV_TVLV_GW		= 0x01,	BATADV_TVLV_DAT		= 0x02,	BATADV_TVLV_NC		= 0x03,	BATADV_TVLV_TT		= 0x04,	BATADV_TVLV_ROAM	= 0x05,	BATADV_TVLV_MCAST	= 0x06,}; #pragma pack(2)/* the destination hardware field in the ARP frame is used to * transport the claim type and the group id */struct batadv_bla_claim_dst {	__u8   magic[3];	/* FF:43:05 */	__u8   type;		/* bla_claimframe */	__be16 group;		/* group id */}; /** * struct batadv_ogm_packet - ogm (routing protocol) packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @flags: contains routing relevant flags - see enum batadv_iv_flags * @seqno: sequence identification * @orig: address of the source node * @prev_sender: address of the previous sender * @reserved: reserved byte for alignment * @tq: transmission quality * @tvlv_len: length of tvlv data following the ogm header */struct batadv_ogm_packet {	__u8   packet_type;	__u8   version;	__u8   ttl;	__u8   flags;	__be32 seqno;	__u8   orig[ETH_ALEN];	__u8   prev_sender[ETH_ALEN];	__u8   reserved;	__u8   tq;	__be16 tvlv_len;}; #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet) /** * struct batadv_ogm2_packet - ogm2 (routing protocol) packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the general header * @ttl: time to live for this packet, part of the general header * @flags: reserved for routing relevant flags - currently always 0 * @seqno: sequence number * @orig: originator mac address * @tvlv_len: length of the appended tvlv buffer (in bytes) * @throughput: the currently flooded path throughput */struct batadv_ogm2_packet {	__u8   packet_type;	__u8   version;	__u8   ttl;	__u8   flags;	__be32 seqno;	__u8   orig[ETH_ALEN];	__be16 tvlv_len;	__be32 throughput;}; #define BATADV_OGM2_HLEN sizeof(struct batadv_ogm2_packet) /** * struct batadv_elp_packet - elp (neighbor discovery) packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @orig: originator mac address * @seqno: sequence number * @elp_interval: currently used ELP sending interval in ms */struct batadv_elp_packet {	__u8   packet_type;	__u8   version;	__u8   orig[ETH_ALEN];	__be32 seqno;	__be32 elp_interval;}; #define BATADV_ELP_HLEN sizeof(struct batadv_elp_packet) /** * struct batadv_icmp_header - common members among all the ICMP packets * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @msg_type: ICMP packet type * @dst: address of the destination node * @orig: address of the source node * @uid: local ICMP socket identifier * @align: not used - useful for alignment purposes only * * This structure is used for ICMP packets parsing only and it is never sent * over the wire. The alignment field at the end is there to ensure that * members are padded the same way as they are in real packets. */struct batadv_icmp_header {	__u8 packet_type;	__u8 version;	__u8 ttl;	__u8 msg_type; /* see ICMP message types above */	__u8 dst[ETH_ALEN];	__u8 orig[ETH_ALEN];	__u8 uid;	__u8 align[3];}; /** * struct batadv_icmp_packet - ICMP packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @msg_type: ICMP packet type * @dst: address of the destination node * @orig: address of the source node * @uid: local ICMP socket identifier * @reserved: not used - useful for alignment * @seqno: ICMP sequence number */struct batadv_icmp_packet {	__u8   packet_type;	__u8   version;	__u8   ttl;	__u8   msg_type; /* see ICMP message types above */	__u8   dst[ETH_ALEN];	__u8   orig[ETH_ALEN];	__u8   uid;	__u8   reserved;	__be16 seqno;}; /** * struct batadv_icmp_tp_packet - ICMP TP Meter packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @msg_type: ICMP packet type * @dst: address of the destination node * @orig: address of the source node * @uid: local ICMP socket identifier * @subtype: TP packet subtype (see batadv_icmp_tp_subtype) * @session: TP session identifier * @seqno: the TP sequence number * @timestamp: time when the packet has been sent. This value is filled in a *  TP_MSG and echoed back in the next TP_ACK so that the sender can compute the *  RTT. Since it is read only by the host which wrote it, there is no need to *  store it using network order */struct batadv_icmp_tp_packet {	__u8   packet_type;	__u8   version;	__u8   ttl;	__u8   msg_type; /* see ICMP message types above */	__u8   dst[ETH_ALEN];	__u8   orig[ETH_ALEN];	__u8   uid;	__u8   subtype;	__u8   session[2];	__be32 seqno;	__be32 timestamp;}; /** * enum batadv_icmp_tp_subtype - ICMP TP Meter packet subtypes * @BATADV_TP_MSG: Msg from sender to receiver * @BATADV_TP_ACK: acknowledgment from receiver to sender */enum batadv_icmp_tp_subtype {	BATADV_TP_MSG	= 0,	BATADV_TP_ACK,}; #define BATADV_RR_LEN 16 /** * struct batadv_icmp_packet_rr - ICMP RouteRecord packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @msg_type: ICMP packet type * @dst: address of the destination node * @orig: address of the source node * @uid: local ICMP socket identifier * @rr_cur: number of entries the rr array * @seqno: ICMP sequence number * @rr: route record array */struct batadv_icmp_packet_rr {	__u8   packet_type;	__u8   version;	__u8   ttl;	__u8   msg_type; /* see ICMP message types above */	__u8   dst[ETH_ALEN];	__u8   orig[ETH_ALEN];	__u8   uid;	__u8   rr_cur;	__be16 seqno;	__u8   rr[BATADV_RR_LEN][ETH_ALEN];}; #define BATADV_ICMP_MAX_PACKET_SIZE	sizeof(struct batadv_icmp_packet_rr) /* All packet headers in front of an ethernet header have to be completely * divisible by 2 but not by 4 to make the payload after the ethernet * header again 4 bytes boundary aligned. * * A packing of 2 is necessary to avoid extra padding at the end of the struct * caused by a structure member which is larger than two bytes. Otherwise * the structure would not fulfill the previously mentioned rule to avoid the * misalignment of the payload after the ethernet header. It may also lead to * leakage of information when the padding it not initialized before sending. */ /** * struct batadv_unicast_packet - unicast packet for network payload * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @ttvn: translation table version number * @dest: originator destination of the unicast packet */struct batadv_unicast_packet {	__u8 packet_type;	__u8 version;	__u8 ttl;	__u8 ttvn; /* destination translation table version number */	__u8 dest[ETH_ALEN];	/* "4 bytes boundary + 2 bytes" long to make the payload after the	 * following ethernet header again 4 bytes boundary aligned	 */}; /** * struct batadv_unicast_4addr_packet - extended unicast packet * @u: common unicast packet header * @src: address of the source * @subtype: packet subtype * @reserved: reserved byte for alignment */struct batadv_unicast_4addr_packet {	struct batadv_unicast_packet u;	__u8 src[ETH_ALEN];	__u8 subtype;	__u8 reserved;	/* "4 bytes boundary + 2 bytes" long to make the payload after the	 * following ethernet header again 4 bytes boundary aligned	 */}; /** * struct batadv_frag_packet - fragmented packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @dest: final destination used when routing fragments * @orig: originator of the fragment used when merging the packet * @no: fragment number within this sequence * @priority: priority of frame, from ToS IP precedence or 802.1p * @reserved: reserved byte for alignment * @seqno: sequence identification * @total_size: size of the merged packet */struct batadv_frag_packet {	__u8   packet_type;	__u8   version;  /* batman version field */	__u8   ttl;#if defined(__BIG_ENDIAN_BITFIELD)	__u8   no:4;	__u8   priority:3;	__u8   reserved:1;#elif defined(__LITTLE_ENDIAN_BITFIELD)	__u8   reserved:1;	__u8   priority:3;	__u8   no:4;#else#error "unknown bitfield endianness"#endif	__u8   dest[ETH_ALEN];	__u8   orig[ETH_ALEN];	__be16 seqno;	__be16 total_size;}; /** * struct batadv_bcast_packet - broadcast packet for network payload * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @reserved: reserved byte for alignment * @seqno: sequence identification * @orig: originator of the broadcast packet */struct batadv_bcast_packet {	__u8   packet_type;	__u8   version;  /* batman version field */	__u8   ttl;	__u8   reserved;	__be32 seqno;	__u8   orig[ETH_ALEN];	/* "4 bytes boundary + 2 bytes" long to make the payload after the	 * following ethernet header again 4 bytes boundary aligned	 */}; /** * struct batadv_coded_packet - network coded packet * @packet_type: batman-adv packet type, part of the general header * @version: batman-adv protocol version, part of the genereal header * @ttl: time to live for this packet, part of the genereal header * @first_source: original source of first included packet * @first_orig_dest: original destinal of first included packet * @first_crc: checksum of first included packet * @first_ttvn: tt-version number of first included packet * @second_ttl: ttl of second packet * @second_dest: second receiver of this coded packet * @second_source: original source of second included packet * @second_orig_dest: original destination of second included packet

Lines 1–500 of 631.