[linux-block.git] / include / uapi / linux / if_packet.h

#ifndef __LINUX_IF_PACKET_H
#define __LINUX_IF_PACKET_H

#include <linux/types.h>

struct sockaddr_pkt {
	unsigned short spkt_family;
	unsigned char spkt_device[14];
	__be16 spkt_protocol;
};

struct sockaddr_ll {
	unsigned short	sll_family;
	__be16		sll_protocol;
	int		sll_ifindex;
	unsigned short	sll_hatype;
	unsigned char	sll_pkttype;
	unsigned char	sll_halen;
	unsigned char	sll_addr[8];
};

/* Packet types */

#define PACKET_HOST		0		/* To us		*/
#define PACKET_BROADCAST	1		/* To all		*/
#define PACKET_MULTICAST	2		/* To group		*/
#define PACKET_OTHERHOST	3		/* To someone else 	*/
#define PACKET_OUTGOING		4		/* Outgoing of any type */
#define PACKET_LOOPBACK		5		/* MC/BRD frame looped back */
#define PACKET_USER		6		/* To user space	*/
#define PACKET_KERNEL		7		/* To kernel space	*/
/* Unused, PACKET_FASTROUTE and PACKET_LOOPBACK are invisible to user space */
#define PACKET_FASTROUTE	6		/* Fastrouted frame	*/

/* Packet socket options */

#define PACKET_ADD_MEMBERSHIP		1
#define PACKET_DROP_MEMBERSHIP		2
#define PACKET_RECV_OUTPUT		3
/* Value 4 is still used by obsolete turbo-packet. */
#define PACKET_RX_RING			5
#define PACKET_STATISTICS		6
#define PACKET_COPY_THRESH		7
#define PACKET_AUXDATA			8
#define PACKET_ORIGDEV			9
#define PACKET_VERSION			10
#define PACKET_HDRLEN			11
#define PACKET_RESERVE			12
#define PACKET_TX_RING			13
#define PACKET_LOSS			14
#define PACKET_VNET_HDR			15
#define PACKET_TX_TIMESTAMP		16
#define PACKET_TIMESTAMP		17
#define PACKET_FANOUT			18
#define PACKET_TX_HAS_OFF		19
#define PACKET_QDISC_BYPASS		20

#define PACKET_FANOUT_HASH		0
#define PACKET_FANOUT_LB		1
#define PACKET_FANOUT_CPU		2
#define PACKET_FANOUT_ROLLOVER		3
#define PACKET_FANOUT_RND		4
#define PACKET_FANOUT_QM		5
#define PACKET_FANOUT_FLAG_ROLLOVER	0x1000
#define PACKET_FANOUT_FLAG_DEFRAG	0x8000

struct tpacket_stats {
	unsigned int	tp_packets;
	unsigned int	tp_drops;
};

struct tpacket_stats_v3 {
	unsigned int	tp_packets;
	unsigned int	tp_drops;
	unsigned int	tp_freeze_q_cnt;
};

union tpacket_stats_u {
	struct tpacket_stats stats1;
	struct tpacket_stats_v3 stats3;
};

struct tpacket_auxdata {
	__u32		tp_status;
	__u32		tp_len;
	__u32		tp_snaplen;
	__u16		tp_mac;
	__u16		tp_net;
	__u16		tp_vlan_tci;
	__u16		tp_vlan_tpid;
};

/* Rx ring - header status */
#define TP_STATUS_KERNEL		      0
#define TP_STATUS_USER			(1 << 0)
#define TP_STATUS_COPY			(1 << 1)
#define TP_STATUS_LOSING		(1 << 2)
#define TP_STATUS_CSUMNOTREADY		(1 << 3)
#define TP_STATUS_VLAN_VALID		(1 << 4) /* auxdata has valid tp_vlan_tci */
#define TP_STATUS_BLK_TMO		(1 << 5)
#define TP_STATUS_VLAN_TPID_VALID	(1 << 6) /* auxdata has valid tp_vlan_tpid */

/* Tx ring - header status */
#define TP_STATUS_AVAILABLE	      0
#define TP_STATUS_SEND_REQUEST	(1 << 0)
#define TP_STATUS_SENDING	(1 << 1)
#define TP_STATUS_WRONG_FORMAT	(1 << 2)

/* Rx and Tx ring - header status */
#define TP_STATUS_TS_SOFTWARE		(1 << 29)
#define TP_STATUS_TS_SYS_HARDWARE	(1 << 30) /* deprecated, never set */
#define TP_STATUS_TS_RAW_HARDWARE	(1 << 31)

/* Rx ring - feature request bits */
#define TP_FT_REQ_FILL_RXHASH	0x1

struct tpacket_hdr {
	unsigned long	tp_status;
	unsigned int	tp_len;
	unsigned int	tp_snaplen;
	unsigned short	tp_mac;
	unsigned short	tp_net;
	unsigned int	tp_sec;
	unsigned int	tp_usec;
};

#define TPACKET_ALIGNMENT	16
#define TPACKET_ALIGN(x)	(((x)+TPACKET_ALIGNMENT-1)&~(TPACKET_ALIGNMENT-1))
#define TPACKET_HDRLEN		(TPACKET_ALIGN(sizeof(struct tpacket_hdr)) + sizeof(struct sockaddr_ll))

struct tpacket2_hdr {
	__u32		tp_status;
	__u32		tp_len;
	__u32		tp_snaplen;
	__u16		tp_mac;
	__u16		tp_net;
	__u32		tp_sec;
	__u32		tp_nsec;
	__u16		tp_vlan_tci;
	__u16		tp_vlan_tpid;
	__u8		tp_padding[4];
};

struct tpacket_hdr_variant1 {
	__u32	tp_rxhash;
	__u32	tp_vlan_tci;
	__u16	tp_vlan_tpid;
	__u16	tp_padding;
};

struct tpacket3_hdr {
	__u32		tp_next_offset;
	__u32		tp_sec;
	__u32		tp_nsec;
	__u32		tp_snaplen;
	__u32		tp_len;
	__u32		tp_status;
	__u16		tp_mac;
	__u16		tp_net;
	/* pkt_hdr variants */
	union {
		struct tpacket_hdr_variant1 hv1;
	};
	__u8		tp_padding[8];
};

struct tpacket_bd_ts {
	unsigned int ts_sec;
	union {
		unsigned int ts_usec;
		unsigned int ts_nsec;
	};
};

struct tpacket_hdr_v1 {
	__u32	block_status;
	__u32	num_pkts;
	__u32	offset_to_first_pkt;

	/* Number of valid bytes (including padding)
	 * blk_len <= tp_block_size
	 */
	__u32	blk_len;

	/*
	 * Quite a few uses of sequence number:
	 * 1. Make sure cache flush etc worked.
	 *    Well, one can argue - why not use the increasing ts below?
	 *    But look at 2. below first.
	 * 2. When you pass around blocks to other user space decoders,
	 *    you can see which blk[s] is[are] outstanding etc.
	 * 3. Validate kernel code.
	 */
	__aligned_u64	seq_num;

	/*
	 * ts_last_pkt:
	 *
	 * Case 1.	Block has 'N'(N >=1) packets and TMO'd(timed out)
	 *		ts_last_pkt == 'time-stamp of last packet' and NOT the
	 *		time when the timer fired and the block was closed.
	 *		By providing the ts of the last packet we can absolutely
	 *		guarantee that time-stamp wise, the first packet in the
	 *		next block will never precede the last packet of the
	 *		previous block.
	 * Case 2.	Block has zero packets and TMO'd
	 *		ts_last_pkt = time when the timer fired and the block
	 *		was closed.
	 * Case 3.	Block has 'N' packets and NO TMO.
	 *		ts_last_pkt = time-stamp of the last pkt in the block.
	 *
	 * ts_first_pkt:
	 *		Is always the time-stamp when the block was opened.
	 *		Case a)	ZERO packets
	 *			No packets to deal with but atleast you know the
	 *			time-interval of this block.
	 *		Case b) Non-zero packets
	 *			Use the ts of the first packet in the block.
	 *
	 */
	struct tpacket_bd_ts	ts_first_pkt, ts_last_pkt;
};

union tpacket_bd_header_u {
	struct tpacket_hdr_v1 bh1;
};

struct tpacket_block_desc {
	__u32 version;
	__u32 offset_to_priv;
	union tpacket_bd_header_u hdr;
};

#define TPACKET2_HDRLEN		(TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll))
#define TPACKET3_HDRLEN		(TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll))

enum tpacket_versions {
	TPACKET_V1,
	TPACKET_V2,
	TPACKET_V3
};

/*
   Frame structure:

   - Start. Frame must be aligned to TPACKET_ALIGNMENT=16
   - struct tpacket_hdr
   - pad to TPACKET_ALIGNMENT=16
   - struct sockaddr_ll
   - Gap, chosen so that packet data (Start+tp_net) alignes to TPACKET_ALIGNMENT=16
   - Start+tp_mac: [ Optional MAC header ]
   - Start+tp_net: Packet data, aligned to TPACKET_ALIGNMENT=16.
   - Pad to align to TPACKET_ALIGNMENT=16
 */

struct tpacket_req {
	unsigned int	tp_block_size;	/* Minimal size of contiguous block */
	unsigned int	tp_block_nr;	/* Number of blocks */
	unsigned int	tp_frame_size;	/* Size of frame */
	unsigned int	tp_frame_nr;	/* Total number of frames */
};

struct tpacket_req3 {
	unsigned int	tp_block_size;	/* Minimal size of contiguous block */
	unsigned int	tp_block_nr;	/* Number of blocks */
	unsigned int	tp_frame_size;	/* Size of frame */
	unsigned int	tp_frame_nr;	/* Total number of frames */
	unsigned int	tp_retire_blk_tov; /* timeout in msecs */
	unsigned int	tp_sizeof_priv; /* offset to private data area */
	unsigned int	tp_feature_req_word;
};

union tpacket_req_u {
	struct tpacket_req	req;
	struct tpacket_req3	req3;
};

struct packet_mreq {
	int		mr_ifindex;
	unsigned short	mr_type;
	unsigned short	mr_alen;
	unsigned char	mr_address[8];
};

#define PACKET_MR_MULTICAST	0
#define PACKET_MR_PROMISC	1
#define PACKET_MR_ALLMULTI	2
#define PACKET_MR_UNICAST	3

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef __LINUX_IF_PACKET_H
	2	#define __LINUX_IF_PACKET_H
	3
0e11c91e AV	4	#include <linux/types.h>
0e11c91e AV	5
d94d9fee	6	struct sockaddr_pkt {
1da177e4 LT	7	unsigned short spkt_family;
1da177e4 LT	8	unsigned char spkt_device[14];
0e11c91e	9	__be16 spkt_protocol;
1da177e4 LT	10	};
1da177e4 LT	11
d94d9fee	12	struct sockaddr_ll {
1da177e4	13	unsigned short sll_family;
0e11c91e	14	__be16 sll_protocol;
1da177e4 LT	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 */
1da177e4	29	#define PACKET_LOOPBACK 5 /* MC/BRD frame looped back */
604d13c9 DB	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 */
1da177e4 LT	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
8dc41944	44	#define PACKET_AUXDATA 8
80feaacb	45	#define PACKET_ORIGDEV 9
bbd6ef87 PM	46	#define PACKET_VERSION 10
bbd6ef87 PM	47	#define PACKET_HDRLEN 11
8913336a	48	#define PACKET_RESERVE 12
69e3c75f JB	49	#define PACKET_TX_RING 13
69e3c75f JB	50	#define PACKET_LOSS 14
bfd5f4a3	51	#define PACKET_VNET_HDR 15
ed85b565	52	#define PACKET_TX_TIMESTAMP 16
614f60fa	53	#define PACKET_TIMESTAMP 17
dc99f600	54	#define PACKET_FANOUT 18
5920cd3a	55	#define PACKET_TX_HAS_OFF 19
d346a3fa	56	#define PACKET_QDISC_BYPASS 20
dc99f600 DM	57
	58	#define PACKET_FANOUT_HASH 0
	59	#define PACKET_FANOUT_LB 1
95ec3eb4	60	#define PACKET_FANOUT_CPU 2
77f65ebd	61	#define PACKET_FANOUT_ROLLOVER 3
5df0ddfb	62	#define PACKET_FANOUT_RND 4
2d36097d	63	#define PACKET_FANOUT_QM 5
77f65ebd	64	#define PACKET_FANOUT_FLAG_ROLLOVER 0x1000
7736d33f	65	#define PACKET_FANOUT_FLAG_DEFRAG 0x8000
1da177e4	66
d94d9fee	67	struct tpacket_stats {
1da177e4 LT	68	unsigned int tp_packets;
	69	unsigned int tp_drops;
	70	};
	71
0d4691ce	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
d94d9fee	83	struct tpacket_auxdata {
8dc41944 HX	84	__u32 tp_status;
	85	__u32 tp_len;
	86	__u32 tp_snaplen;
	87	__u16 tp_mac;
	88	__u16 tp_net;
393e52e3	89	__u16 tp_vlan_tci;
a0cdfcf3	90	__u16 tp_vlan_tpid;
8dc41944 HX	91	};
8dc41944 HX	92
69e3c75f	93	/* Rx ring - header status */
a0cdfcf3 AW	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 */
69e3c75f JB	102
69e3c75f JB	103	/* Tx ring - header status */
7276d5d7 DB	104	#define TP_STATUS_AVAILABLE 0
	105	#define TP_STATUS_SEND_REQUEST (1 << 0)
	106	#define TP_STATUS_SENDING (1 << 1)
	107	#define TP_STATUS_WRONG_FORMAT (1 << 2)
69e3c75f	108
b9c32fb2 DB	109	/* Rx and Tx ring - header status */
b9c32fb2 DB	110	#define TP_STATUS_TS_SOFTWARE (1 << 29)
68a360e8	111	#define TP_STATUS_TS_SYS_HARDWARE (1 << 30) /* deprecated, never set */
b9c32fb2 DB	112	#define TP_STATUS_TS_RAW_HARDWARE (1 << 31)
b9c32fb2 DB	113
0d4691ce	114	/* Rx ring - feature request bits */
	115	#define TP_FT_REQ_FILL_RXHASH 0x1
	116
d94d9fee	117	struct tpacket_hdr {
1da177e4	118	unsigned long tp_status;
1da177e4 LT	119	unsigned int tp_len;
	120	unsigned int tp_snaplen;
	121	unsigned short tp_mac;
	122	unsigned short tp_net;
	123	unsigned int tp_sec;
	124	unsigned int tp_usec;
	125	};
	126
	127	#define TPACKET_ALIGNMENT 16
	128	#define TPACKET_ALIGN(x) (((x)+TPACKET_ALIGNMENT-1)&~(TPACKET_ALIGNMENT-1))
	129	#define TPACKET_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket_hdr)) + sizeof(struct sockaddr_ll))
	130
d94d9fee	131	struct tpacket2_hdr {
bbd6ef87 PM	132	__u32 tp_status;
	133	__u32 tp_len;
	134	__u32 tp_snaplen;
	135	__u16 tp_mac;
	136	__u16 tp_net;
	137	__u32 tp_sec;
	138	__u32 tp_nsec;
393e52e3	139	__u16 tp_vlan_tci;
a0cdfcf3 AW	140	__u16 tp_vlan_tpid;
a0cdfcf3 AW	141	__u8 tp_padding[4];
bbd6ef87 PM	142	};
bbd6ef87 PM	143
bc59ba39	144	struct tpacket_hdr_variant1 {
0d4691ce	145	__u32 tp_rxhash;
0d4691ce	146	__u32 tp_vlan_tci;
a0cdfcf3 AW	147	__u16 tp_vlan_tpid;
a0cdfcf3 AW	148	__u16 tp_padding;
0d4691ce	149	};
	150
	151	struct tpacket3_hdr {
	152	__u32 tp_next_offset;
	153	__u32 tp_sec;
	154	__u32 tp_nsec;
	155	__u32 tp_snaplen;
	156	__u32 tp_len;
	157	__u32 tp_status;
	158	__u16 tp_mac;
	159	__u16 tp_net;
	160	/* pkt_hdr variants */
	161	union {
bc59ba39	162	struct tpacket_hdr_variant1 hv1;
0d4691ce	163	};
a0cdfcf3	164	__u8 tp_padding[8];
0d4691ce	165	};
0d4691ce	166
bc59ba39	167	struct tpacket_bd_ts {
0d4691ce	168	unsigned int ts_sec;
	169	union {
	170	unsigned int ts_usec;
	171	unsigned int ts_nsec;
	172	};
	173	};
	174
bc59ba39	175	struct tpacket_hdr_v1 {
0d4691ce	176	__u32 block_status;
	177	__u32 num_pkts;
	178	__u32 offset_to_first_pkt;
	179
	180	/* Number of valid bytes (including padding)
	181	* blk_len <= tp_block_size
	182	*/
	183	__u32 blk_len;
	184
	185	/*
	186	* Quite a few uses of sequence number:
	187	* 1. Make sure cache flush etc worked.
	188	* Well, one can argue - why not use the increasing ts below?
	189	* But look at 2. below first.
	190	* 2. When you pass around blocks to other user space decoders,
	191	* you can see which blk[s] is[are] outstanding etc.
	192	* 3. Validate kernel code.
	193	*/
96c13184	194	__aligned_u64 seq_num;
0d4691ce	195
	196	/*
	197	* ts_last_pkt:
	198	*
	199	* Case 1. Block has 'N'(N >=1) packets and TMO'd(timed out)
	200	* ts_last_pkt == 'time-stamp of last packet' and NOT the
	201	* time when the timer fired and the block was closed.
	202	* By providing the ts of the last packet we can absolutely
	203	* guarantee that time-stamp wise, the first packet in the
	204	* next block will never precede the last packet of the
	205	* previous block.
	206	* Case 2. Block has zero packets and TMO'd
	207	* ts_last_pkt = time when the timer fired and the block
	208	* was closed.
	209	* Case 3. Block has 'N' packets and NO TMO.
	210	* ts_last_pkt = time-stamp of the last pkt in the block.
	211	*
	212	* ts_first_pkt:
	213	* Is always the time-stamp when the block was opened.
	214	* Case a) ZERO packets
	215	* No packets to deal with but atleast you know the
	216	* time-interval of this block.
	217	* Case b) Non-zero packets
	218	* Use the ts of the first packet in the block.
	219	*
	220	*/
bc59ba39	221	struct tpacket_bd_ts ts_first_pkt, ts_last_pkt;
0d4691ce	222	};
0d4691ce	223
bc59ba39	224	union tpacket_bd_header_u {
bc59ba39	225	struct tpacket_hdr_v1 bh1;
0d4691ce	226	};
0d4691ce	227
bc59ba39	228	struct tpacket_block_desc {
0d4691ce	229	__u32 version;
0d4691ce	230	__u32 offset_to_priv;
bc59ba39	231	union tpacket_bd_header_u hdr;
0d4691ce	232	};
0d4691ce	233
bbd6ef87	234	#define TPACKET2_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll))
0d4691ce	235	#define TPACKET3_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll))
bbd6ef87	236
d94d9fee	237	enum tpacket_versions {
bbd6ef87 PM	238	TPACKET_V1,
bbd6ef87 PM	239	TPACKET_V2,
0d4691ce	240	TPACKET_V3
bbd6ef87 PM	241	};
bbd6ef87 PM	242
1da177e4 LT	243	/*
	244	Frame structure:
	245
	246	- Start. Frame must be aligned to TPACKET_ALIGNMENT=16
	247	- struct tpacket_hdr
	248	- pad to TPACKET_ALIGNMENT=16
	249	- struct sockaddr_ll
	250	- Gap, chosen so that packet data (Start+tp_net) alignes to TPACKET_ALIGNMENT=16
	251	- Start+tp_mac: [ Optional MAC header ]
	252	- Start+tp_net: Packet data, aligned to TPACKET_ALIGNMENT=16.
	253	- Pad to align to TPACKET_ALIGNMENT=16
	254	*/
	255
d94d9fee	256	struct tpacket_req {
1da177e4 LT	257	unsigned int tp_block_size; /* Minimal size of contiguous block */
	258	unsigned int tp_block_nr; /* Number of blocks */
	259	unsigned int tp_frame_size; /* Size of frame */
	260	unsigned int tp_frame_nr; /* Total number of frames */
	261	};
	262
0d4691ce	263	struct tpacket_req3 {
	264	unsigned int tp_block_size; /* Minimal size of contiguous block */
	265	unsigned int tp_block_nr; /* Number of blocks */
	266	unsigned int tp_frame_size; /* Size of frame */
	267	unsigned int tp_frame_nr; /* Total number of frames */
	268	unsigned int tp_retire_blk_tov; /* timeout in msecs */
	269	unsigned int tp_sizeof_priv; /* offset to private data area */
	270	unsigned int tp_feature_req_word;
	271	};
	272
	273	union tpacket_req_u {
	274	struct tpacket_req req;
	275	struct tpacket_req3 req3;
	276	};
	277
d94d9fee	278	struct packet_mreq {
1da177e4 LT	279	int mr_ifindex;
	280	unsigned short mr_type;
	281	unsigned short mr_alen;
	282	unsigned char mr_address[8];
	283	};
	284
	285	#define PACKET_MR_MULTICAST 0
	286	#define PACKET_MR_PROMISC 1
	287	#define PACKET_MR_ALLMULTI 2
d95ed927	288	#define PACKET_MR_UNICAST 3
1da177e4 LT	289
1da177e4 LT	290	#endif