]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/uapi/linux/if_packet.h
Merge tag 'drm-misc-fixes-2018-01-24' of git://anongit.freedesktop.org/drm/drm-misc...
[mirror_ubuntu-bionic-kernel.git] / include / uapi / linux / if_packet.h
CommitLineData
6f52b16c 1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
1da177e4
LT
2#ifndef __LINUX_IF_PACKET_H
3#define __LINUX_IF_PACKET_H
4
0e11c91e
AV
5#include <linux/types.h>
6
d94d9fee 7struct sockaddr_pkt {
1da177e4
LT
8 unsigned short spkt_family;
9 unsigned char spkt_device[14];
0e11c91e 10 __be16 spkt_protocol;
1da177e4
LT
11};
12
d94d9fee 13struct sockaddr_ll {
1da177e4 14 unsigned short sll_family;
0e11c91e 15 __be16 sll_protocol;
1da177e4
LT
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 */
1da177e4 30#define PACKET_LOOPBACK 5 /* MC/BRD frame looped back */
604d13c9
DB
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 */
1da177e4
LT
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
8dc41944 45#define PACKET_AUXDATA 8
80feaacb 46#define PACKET_ORIGDEV 9
bbd6ef87
PM
47#define PACKET_VERSION 10
48#define PACKET_HDRLEN 11
8913336a 49#define PACKET_RESERVE 12
69e3c75f
JB
50#define PACKET_TX_RING 13
51#define PACKET_LOSS 14
bfd5f4a3 52#define PACKET_VNET_HDR 15
ed85b565 53#define PACKET_TX_TIMESTAMP 16
614f60fa 54#define PACKET_TIMESTAMP 17
dc99f600 55#define PACKET_FANOUT 18
5920cd3a 56#define PACKET_TX_HAS_OFF 19
d346a3fa 57#define PACKET_QDISC_BYPASS 20
a9b63918 58#define PACKET_ROLLOVER_STATS 21
47dceb8e 59#define PACKET_FANOUT_DATA 22
dc99f600
DM
60
61#define PACKET_FANOUT_HASH 0
62#define PACKET_FANOUT_LB 1
95ec3eb4 63#define PACKET_FANOUT_CPU 2
77f65ebd 64#define PACKET_FANOUT_ROLLOVER 3
5df0ddfb 65#define PACKET_FANOUT_RND 4
2d36097d 66#define PACKET_FANOUT_QM 5
47dceb8e 67#define PACKET_FANOUT_CBPF 6
f2e52095 68#define PACKET_FANOUT_EBPF 7
77f65ebd 69#define PACKET_FANOUT_FLAG_ROLLOVER 0x1000
4a69a864 70#define PACKET_FANOUT_FLAG_UNIQUEID 0x2000
7736d33f 71#define PACKET_FANOUT_FLAG_DEFRAG 0x8000
1da177e4 72
d94d9fee 73struct tpacket_stats {
1da177e4
LT
74 unsigned int tp_packets;
75 unsigned int tp_drops;
76};
77
0d4691ce 78struct tpacket_stats_v3 {
79 unsigned int tp_packets;
80 unsigned int tp_drops;
81 unsigned int tp_freeze_q_cnt;
82};
83
a9b63918
WB
84struct tpacket_rollover_stats {
85 __aligned_u64 tp_all;
86 __aligned_u64 tp_huge;
87 __aligned_u64 tp_failed;
88};
89
0d4691ce 90union tpacket_stats_u {
91 struct tpacket_stats stats1;
92 struct tpacket_stats_v3 stats3;
93};
94
d94d9fee 95struct tpacket_auxdata {
8dc41944
HX
96 __u32 tp_status;
97 __u32 tp_len;
98 __u32 tp_snaplen;
99 __u16 tp_mac;
100 __u16 tp_net;
393e52e3 101 __u16 tp_vlan_tci;
a0cdfcf3 102 __u16 tp_vlan_tpid;
8dc41944
HX
103};
104
69e3c75f 105/* Rx ring - header status */
a0cdfcf3
AW
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 */
682f048b 114#define TP_STATUS_CSUM_VALID (1 << 7)
69e3c75f
JB
115
116/* Tx ring - header status */
7276d5d7
DB
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)
69e3c75f 121
b9c32fb2
DB
122/* Rx and Tx ring - header status */
123#define TP_STATUS_TS_SOFTWARE (1 << 29)
68a360e8 124#define TP_STATUS_TS_SYS_HARDWARE (1 << 30) /* deprecated, never set */
b9c32fb2
DB
125#define TP_STATUS_TS_RAW_HARDWARE (1 << 31)
126
0d4691ce 127/* Rx ring - feature request bits */
128#define TP_FT_REQ_FILL_RXHASH 0x1
129
d94d9fee 130struct tpacket_hdr {
1da177e4 131 unsigned long tp_status;
1da177e4
LT
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
d94d9fee 144struct tpacket2_hdr {
bbd6ef87
PM
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;
393e52e3 152 __u16 tp_vlan_tci;
a0cdfcf3
AW
153 __u16 tp_vlan_tpid;
154 __u8 tp_padding[4];
bbd6ef87
PM
155};
156
bc59ba39 157struct tpacket_hdr_variant1 {
0d4691ce 158 __u32 tp_rxhash;
159 __u32 tp_vlan_tci;
a0cdfcf3
AW
160 __u16 tp_vlan_tpid;
161 __u16 tp_padding;
0d4691ce 162};
163
164struct 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 {
bc59ba39 175 struct tpacket_hdr_variant1 hv1;
0d4691ce 176 };
a0cdfcf3 177 __u8 tp_padding[8];
0d4691ce 178};
179
bc59ba39 180struct tpacket_bd_ts {
0d4691ce 181 unsigned int ts_sec;
182 union {
183 unsigned int ts_usec;
184 unsigned int ts_nsec;
185 };
186};
187
bc59ba39 188struct tpacket_hdr_v1 {
0d4691ce 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 */
96c13184 207 __aligned_u64 seq_num;
0d4691ce 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 */
bc59ba39 234 struct tpacket_bd_ts ts_first_pkt, ts_last_pkt;
0d4691ce 235};
236
bc59ba39 237union tpacket_bd_header_u {
238 struct tpacket_hdr_v1 bh1;
0d4691ce 239};
240
bc59ba39 241struct tpacket_block_desc {
0d4691ce 242 __u32 version;
243 __u32 offset_to_priv;
bc59ba39 244 union tpacket_bd_header_u hdr;
0d4691ce 245};
246
bbd6ef87 247#define TPACKET2_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll))
0d4691ce 248#define TPACKET3_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll))
bbd6ef87 249
d94d9fee 250enum tpacket_versions {
bbd6ef87
PM
251 TPACKET_V1,
252 TPACKET_V2,
0d4691ce 253 TPACKET_V3
bbd6ef87
PM
254};
255
1da177e4
LT
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
d94d9fee 269struct tpacket_req {
1da177e4
LT
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
0d4691ce 276struct 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
286union tpacket_req_u {
287 struct tpacket_req req;
288 struct tpacket_req3 req3;
289};
290
d94d9fee 291struct packet_mreq {
1da177e4
LT
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
d95ed927 301#define PACKET_MR_UNICAST 3
1da177e4
LT
302
303#endif