xref: /linux-6.15/include/uapi/linux/if_packet.h (revision d346a3fa)
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_padding;
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 
99 /* Tx ring - header status */
100 #define TP_STATUS_AVAILABLE	      0
101 #define TP_STATUS_SEND_REQUEST	(1 << 0)
102 #define TP_STATUS_SENDING	(1 << 1)
103 #define TP_STATUS_WRONG_FORMAT	(1 << 2)
104 
105 /* Rx and Tx ring - header status */
106 #define TP_STATUS_TS_SOFTWARE		(1 << 29)
107 #define TP_STATUS_TS_SYS_HARDWARE	(1 << 30)
108 #define TP_STATUS_TS_RAW_HARDWARE	(1 << 31)
109 
110 /* Rx ring - feature request bits */
111 #define TP_FT_REQ_FILL_RXHASH	0x1
112 
113 struct tpacket_hdr {
114 	unsigned long	tp_status;
115 	unsigned int	tp_len;
116 	unsigned int	tp_snaplen;
117 	unsigned short	tp_mac;
118 	unsigned short	tp_net;
119 	unsigned int	tp_sec;
120 	unsigned int	tp_usec;
121 };
122 
123 #define TPACKET_ALIGNMENT	16
124 #define TPACKET_ALIGN(x)	(((x)+TPACKET_ALIGNMENT-1)&~(TPACKET_ALIGNMENT-1))
125 #define TPACKET_HDRLEN		(TPACKET_ALIGN(sizeof(struct tpacket_hdr)) + sizeof(struct sockaddr_ll))
126 
127 struct tpacket2_hdr {
128 	__u32		tp_status;
129 	__u32		tp_len;
130 	__u32		tp_snaplen;
131 	__u16		tp_mac;
132 	__u16		tp_net;
133 	__u32		tp_sec;
134 	__u32		tp_nsec;
135 	__u16		tp_vlan_tci;
136 	__u16		tp_padding;
137 };
138 
139 struct tpacket_hdr_variant1 {
140 	__u32	tp_rxhash;
141 	__u32	tp_vlan_tci;
142 };
143 
144 struct tpacket3_hdr {
145 	__u32		tp_next_offset;
146 	__u32		tp_sec;
147 	__u32		tp_nsec;
148 	__u32		tp_snaplen;
149 	__u32		tp_len;
150 	__u32		tp_status;
151 	__u16		tp_mac;
152 	__u16		tp_net;
153 	/* pkt_hdr variants */
154 	union {
155 		struct tpacket_hdr_variant1 hv1;
156 	};
157 };
158 
159 struct tpacket_bd_ts {
160 	unsigned int ts_sec;
161 	union {
162 		unsigned int ts_usec;
163 		unsigned int ts_nsec;
164 	};
165 };
166 
167 struct tpacket_hdr_v1 {
168 	__u32	block_status;
169 	__u32	num_pkts;
170 	__u32	offset_to_first_pkt;
171 
172 	/* Number of valid bytes (including padding)
173 	 * blk_len <= tp_block_size
174 	 */
175 	__u32	blk_len;
176 
177 	/*
178 	 * Quite a few uses of sequence number:
179 	 * 1. Make sure cache flush etc worked.
180 	 *    Well, one can argue - why not use the increasing ts below?
181 	 *    But look at 2. below first.
182 	 * 2. When you pass around blocks to other user space decoders,
183 	 *    you can see which blk[s] is[are] outstanding etc.
184 	 * 3. Validate kernel code.
185 	 */
186 	__aligned_u64	seq_num;
187 
188 	/*
189 	 * ts_last_pkt:
190 	 *
191 	 * Case 1.	Block has 'N'(N >=1) packets and TMO'd(timed out)
192 	 *		ts_last_pkt == 'time-stamp of last packet' and NOT the
193 	 *		time when the timer fired and the block was closed.
194 	 *		By providing the ts of the last packet we can absolutely
195 	 *		guarantee that time-stamp wise, the first packet in the
196 	 *		next block will never precede the last packet of the
197 	 *		previous block.
198 	 * Case 2.	Block has zero packets and TMO'd
199 	 *		ts_last_pkt = time when the timer fired and the block
200 	 *		was closed.
201 	 * Case 3.	Block has 'N' packets and NO TMO.
202 	 *		ts_last_pkt = time-stamp of the last pkt in the block.
203 	 *
204 	 * ts_first_pkt:
205 	 *		Is always the time-stamp when the block was opened.
206 	 *		Case a)	ZERO packets
207 	 *			No packets to deal with but atleast you know the
208 	 *			time-interval of this block.
209 	 *		Case b) Non-zero packets
210 	 *			Use the ts of the first packet in the block.
211 	 *
212 	 */
213 	struct tpacket_bd_ts	ts_first_pkt, ts_last_pkt;
214 };
215 
216 union tpacket_bd_header_u {
217 	struct tpacket_hdr_v1 bh1;
218 };
219 
220 struct tpacket_block_desc {
221 	__u32 version;
222 	__u32 offset_to_priv;
223 	union tpacket_bd_header_u hdr;
224 };
225 
226 #define TPACKET2_HDRLEN		(TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll))
227 #define TPACKET3_HDRLEN		(TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll))
228 
229 enum tpacket_versions {
230 	TPACKET_V1,
231 	TPACKET_V2,
232 	TPACKET_V3
233 };
234 
235 /*
236    Frame structure:
237 
238    - Start. Frame must be aligned to TPACKET_ALIGNMENT=16
239    - struct tpacket_hdr
240    - pad to TPACKET_ALIGNMENT=16
241    - struct sockaddr_ll
242    - Gap, chosen so that packet data (Start+tp_net) alignes to TPACKET_ALIGNMENT=16
243    - Start+tp_mac: [ Optional MAC header ]
244    - Start+tp_net: Packet data, aligned to TPACKET_ALIGNMENT=16.
245    - Pad to align to TPACKET_ALIGNMENT=16
246  */
247 
248 struct tpacket_req {
249 	unsigned int	tp_block_size;	/* Minimal size of contiguous block */
250 	unsigned int	tp_block_nr;	/* Number of blocks */
251 	unsigned int	tp_frame_size;	/* Size of frame */
252 	unsigned int	tp_frame_nr;	/* Total number of frames */
253 };
254 
255 struct tpacket_req3 {
256 	unsigned int	tp_block_size;	/* Minimal size of contiguous block */
257 	unsigned int	tp_block_nr;	/* Number of blocks */
258 	unsigned int	tp_frame_size;	/* Size of frame */
259 	unsigned int	tp_frame_nr;	/* Total number of frames */
260 	unsigned int	tp_retire_blk_tov; /* timeout in msecs */
261 	unsigned int	tp_sizeof_priv; /* offset to private data area */
262 	unsigned int	tp_feature_req_word;
263 };
264 
265 union tpacket_req_u {
266 	struct tpacket_req	req;
267 	struct tpacket_req3	req3;
268 };
269 
270 struct packet_mreq {
271 	int		mr_ifindex;
272 	unsigned short	mr_type;
273 	unsigned short	mr_alen;
274 	unsigned char	mr_address[8];
275 };
276 
277 #define PACKET_MR_MULTICAST	0
278 #define PACKET_MR_PROMISC	1
279 #define PACKET_MR_ALLMULTI	2
280 #define PACKET_MR_UNICAST	3
281 
282 #endif
283