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