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