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