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