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