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