1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 #ifndef __LINUX_IF_PACKET_H 3 #define __LINUX_IF_PACKET_H 4 5 #include <asm/byteorder.h> 6 #include <linux/types.h> 7 8 struct sockaddr_pkt { 9 unsigned short spkt_family; 10 unsigned char spkt_device[14]; 11 __be16 spkt_protocol; 12 }; 13 14 struct sockaddr_ll { 15 unsigned short sll_family; 16 __be16 sll_protocol; 17 int sll_ifindex; 18 unsigned short sll_hatype; 19 unsigned char sll_pkttype; 20 unsigned char sll_halen; 21 unsigned char sll_addr[8]; 22 }; 23 24 /* Packet types */ 25 26 #define PACKET_HOST 0 /* To us */ 27 #define PACKET_BROADCAST 1 /* To all */ 28 #define PACKET_MULTICAST 2 /* To group */ 29 #define PACKET_OTHERHOST 3 /* To someone else */ 30 #define PACKET_OUTGOING 4 /* Outgoing of any type */ 31 #define PACKET_LOOPBACK 5 /* MC/BRD frame looped back */ 32 #define PACKET_USER 6 /* To user space */ 33 #define PACKET_KERNEL 7 /* To kernel space */ 34 /* Unused, PACKET_FASTROUTE and PACKET_LOOPBACK are invisible to user space */ 35 #define PACKET_FASTROUTE 6 /* Fastrouted frame */ 36 37 /* Packet socket options */ 38 39 #define PACKET_ADD_MEMBERSHIP 1 40 #define PACKET_DROP_MEMBERSHIP 2 41 #define PACKET_RECV_OUTPUT 3 42 /* Value 4 is still used by obsolete turbo-packet. */ 43 #define PACKET_RX_RING 5 44 #define PACKET_STATISTICS 6 45 #define PACKET_COPY_THRESH 7 46 #define PACKET_AUXDATA 8 47 #define PACKET_ORIGDEV 9 48 #define PACKET_VERSION 10 49 #define PACKET_HDRLEN 11 50 #define PACKET_RESERVE 12 51 #define PACKET_TX_RING 13 52 #define PACKET_LOSS 14 53 #define PACKET_VNET_HDR 15 54 #define PACKET_TX_TIMESTAMP 16 55 #define PACKET_TIMESTAMP 17 56 #define PACKET_FANOUT 18 57 #define PACKET_TX_HAS_OFF 19 58 #define PACKET_QDISC_BYPASS 20 59 #define PACKET_ROLLOVER_STATS 21 60 #define PACKET_FANOUT_DATA 22 61 #define PACKET_IGNORE_OUTGOING 23 62 63 #define PACKET_FANOUT_HASH 0 64 #define PACKET_FANOUT_LB 1 65 #define PACKET_FANOUT_CPU 2 66 #define PACKET_FANOUT_ROLLOVER 3 67 #define PACKET_FANOUT_RND 4 68 #define PACKET_FANOUT_QM 5 69 #define PACKET_FANOUT_CBPF 6 70 #define PACKET_FANOUT_EBPF 7 71 #define PACKET_FANOUT_FLAG_ROLLOVER 0x1000 72 #define PACKET_FANOUT_FLAG_UNIQUEID 0x2000 73 #define PACKET_FANOUT_FLAG_IGNORE_OUTGOING 0x4000 74 #define PACKET_FANOUT_FLAG_DEFRAG 0x8000 75 76 struct tpacket_stats { 77 unsigned int tp_packets; 78 unsigned int tp_drops; 79 }; 80 81 struct tpacket_stats_v3 { 82 unsigned int tp_packets; 83 unsigned int tp_drops; 84 unsigned int tp_freeze_q_cnt; 85 }; 86 87 struct tpacket_rollover_stats { 88 __aligned_u64 tp_all; 89 __aligned_u64 tp_huge; 90 __aligned_u64 tp_failed; 91 }; 92 93 union tpacket_stats_u { 94 struct tpacket_stats stats1; 95 struct tpacket_stats_v3 stats3; 96 }; 97 98 struct tpacket_auxdata { 99 __u32 tp_status; 100 __u32 tp_len; 101 __u32 tp_snaplen; 102 __u16 tp_mac; 103 __u16 tp_net; 104 __u16 tp_vlan_tci; 105 __u16 tp_vlan_tpid; 106 }; 107 108 /* Rx ring - header status */ 109 #define TP_STATUS_KERNEL 0 110 #define TP_STATUS_USER (1 << 0) 111 #define TP_STATUS_COPY (1 << 1) 112 #define TP_STATUS_LOSING (1 << 2) 113 #define TP_STATUS_CSUMNOTREADY (1 << 3) 114 #define TP_STATUS_VLAN_VALID (1 << 4) /* auxdata has valid tp_vlan_tci */ 115 #define TP_STATUS_BLK_TMO (1 << 5) 116 #define TP_STATUS_VLAN_TPID_VALID (1 << 6) /* auxdata has valid tp_vlan_tpid */ 117 #define TP_STATUS_CSUM_VALID (1 << 7) 118 #define TP_STATUS_GSO_TCP (1 << 8) 119 120 /* Tx ring - header status */ 121 #define TP_STATUS_AVAILABLE 0 122 #define TP_STATUS_SEND_REQUEST (1 << 0) 123 #define TP_STATUS_SENDING (1 << 1) 124 #define TP_STATUS_WRONG_FORMAT (1 << 2) 125 126 /* Rx and Tx ring - header status */ 127 #define TP_STATUS_TS_SOFTWARE (1 << 29) 128 #define TP_STATUS_TS_SYS_HARDWARE (1 << 30) /* deprecated, never set */ 129 #define TP_STATUS_TS_RAW_HARDWARE (1U << 31) 130 131 /* Rx ring - feature request bits */ 132 #define TP_FT_REQ_FILL_RXHASH 0x1 133 134 struct tpacket_hdr { 135 unsigned long tp_status; 136 unsigned int tp_len; 137 unsigned int tp_snaplen; 138 unsigned short tp_mac; 139 unsigned short tp_net; 140 unsigned int tp_sec; 141 unsigned int tp_usec; 142 }; 143 144 #define TPACKET_ALIGNMENT 16 145 #define TPACKET_ALIGN(x) (((x)+TPACKET_ALIGNMENT-1)&~(TPACKET_ALIGNMENT-1)) 146 #define TPACKET_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket_hdr)) + sizeof(struct sockaddr_ll)) 147 148 struct tpacket2_hdr { 149 __u32 tp_status; 150 __u32 tp_len; 151 __u32 tp_snaplen; 152 __u16 tp_mac; 153 __u16 tp_net; 154 __u32 tp_sec; 155 __u32 tp_nsec; 156 __u16 tp_vlan_tci; 157 __u16 tp_vlan_tpid; 158 __u8 tp_padding[4]; 159 }; 160 161 struct tpacket_hdr_variant1 { 162 __u32 tp_rxhash; 163 __u32 tp_vlan_tci; 164 __u16 tp_vlan_tpid; 165 __u16 tp_padding; 166 }; 167 168 struct tpacket3_hdr { 169 __u32 tp_next_offset; 170 __u32 tp_sec; 171 __u32 tp_nsec; 172 __u32 tp_snaplen; 173 __u32 tp_len; 174 __u32 tp_status; 175 __u16 tp_mac; 176 __u16 tp_net; 177 /* pkt_hdr variants */ 178 union { 179 struct tpacket_hdr_variant1 hv1; 180 }; 181 __u8 tp_padding[8]; 182 }; 183 184 struct tpacket_bd_ts { 185 unsigned int ts_sec; 186 union { 187 unsigned int ts_usec; 188 unsigned int ts_nsec; 189 }; 190 }; 191 192 struct tpacket_hdr_v1 { 193 __u32 block_status; 194 __u32 num_pkts; 195 __u32 offset_to_first_pkt; 196 197 /* Number of valid bytes (including padding) 198 * blk_len <= tp_block_size 199 */ 200 __u32 blk_len; 201 202 /* 203 * Quite a few uses of sequence number: 204 * 1. Make sure cache flush etc worked. 205 * Well, one can argue - why not use the increasing ts below? 206 * But look at 2. below first. 207 * 2. When you pass around blocks to other user space decoders, 208 * you can see which blk[s] is[are] outstanding etc. 209 * 3. Validate kernel code. 210 */ 211 __aligned_u64 seq_num; 212 213 /* 214 * ts_last_pkt: 215 * 216 * Case 1. Block has 'N'(N >=1) packets and TMO'd(timed out) 217 * ts_last_pkt == 'time-stamp of last packet' and NOT the 218 * time when the timer fired and the block was closed. 219 * By providing the ts of the last packet we can absolutely 220 * guarantee that time-stamp wise, the first packet in the 221 * next block will never precede the last packet of the 222 * previous block. 223 * Case 2. Block has zero packets and TMO'd 224 * ts_last_pkt = time when the timer fired and the block 225 * was closed. 226 * Case 3. Block has 'N' packets and NO TMO. 227 * ts_last_pkt = time-stamp of the last pkt in the block. 228 * 229 * ts_first_pkt: 230 * Is always the time-stamp when the block was opened. 231 * Case a) ZERO packets 232 * No packets to deal with but atleast you know the 233 * time-interval of this block. 234 * Case b) Non-zero packets 235 * Use the ts of the first packet in the block. 236 * 237 */ 238 struct tpacket_bd_ts ts_first_pkt, ts_last_pkt; 239 }; 240 241 union tpacket_bd_header_u { 242 struct tpacket_hdr_v1 bh1; 243 }; 244 245 struct tpacket_block_desc { 246 __u32 version; 247 __u32 offset_to_priv; 248 union tpacket_bd_header_u hdr; 249 }; 250 251 #define TPACKET2_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll)) 252 #define TPACKET3_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll)) 253 254 enum tpacket_versions { 255 TPACKET_V1, 256 TPACKET_V2, 257 TPACKET_V3 258 }; 259 260 /* 261 Frame structure: 262 263 - Start. Frame must be aligned to TPACKET_ALIGNMENT=16 264 - struct tpacket_hdr 265 - pad to TPACKET_ALIGNMENT=16 266 - struct sockaddr_ll 267 - Gap, chosen so that packet data (Start+tp_net) alignes to TPACKET_ALIGNMENT=16 268 - Start+tp_mac: [ Optional MAC header ] 269 - Start+tp_net: Packet data, aligned to TPACKET_ALIGNMENT=16. 270 - Pad to align to TPACKET_ALIGNMENT=16 271 */ 272 273 struct tpacket_req { 274 unsigned int tp_block_size; /* Minimal size of contiguous block */ 275 unsigned int tp_block_nr; /* Number of blocks */ 276 unsigned int tp_frame_size; /* Size of frame */ 277 unsigned int tp_frame_nr; /* Total number of frames */ 278 }; 279 280 struct tpacket_req3 { 281 unsigned int tp_block_size; /* Minimal size of contiguous block */ 282 unsigned int tp_block_nr; /* Number of blocks */ 283 unsigned int tp_frame_size; /* Size of frame */ 284 unsigned int tp_frame_nr; /* Total number of frames */ 285 unsigned int tp_retire_blk_tov; /* timeout in msecs */ 286 unsigned int tp_sizeof_priv; /* offset to private data area */ 287 unsigned int tp_feature_req_word; 288 }; 289 290 union tpacket_req_u { 291 struct tpacket_req req; 292 struct tpacket_req3 req3; 293 }; 294 295 struct packet_mreq { 296 int mr_ifindex; 297 unsigned short mr_type; 298 unsigned short mr_alen; 299 unsigned char mr_address[8]; 300 }; 301 302 struct fanout_args { 303 #if defined(__LITTLE_ENDIAN_BITFIELD) 304 __u16 id; 305 __u16 type_flags; 306 #else 307 __u16 type_flags; 308 __u16 id; 309 #endif 310 __u32 max_num_members; 311 }; 312 313 #define PACKET_MR_MULTICAST 0 314 #define PACKET_MR_PROMISC 1 315 #define PACKET_MR_ALLMULTI 2 316 #define PACKET_MR_UNICAST 3 317 318 #endif 319