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