[mirror_ubuntu-bionic-kernel.git] / net / packet / internal.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PACKET_INTERNAL_H__
#define __PACKET_INTERNAL_H__

#include <linux/refcount.h>

struct packet_mclist {
	struct packet_mclist	*next;
	int			ifindex;
	int			count;
	unsigned short		type;
	unsigned short		alen;
	unsigned char		addr[MAX_ADDR_LEN];
};

/* kbdq - kernel block descriptor queue */
struct tpacket_kbdq_core {
	struct pgv	*pkbdq;
	unsigned int	feature_req_word;
	unsigned int	hdrlen;
	unsigned char	reset_pending_on_curr_blk;
	unsigned char   delete_blk_timer;
	unsigned short	kactive_blk_num;
	unsigned short	blk_sizeof_priv;

	/* last_kactive_blk_num:
	 * trick to see if user-space has caught up
	 * in order to avoid refreshing timer when every single pkt arrives.
	 */
	unsigned short	last_kactive_blk_num;

	char		*pkblk_start;
	char		*pkblk_end;
	int		kblk_size;
	unsigned int	max_frame_len;
	unsigned int	knum_blocks;
	uint64_t	knxt_seq_num;
	char		*prev;
	char		*nxt_offset;
	struct sk_buff	*skb;

	atomic_t	blk_fill_in_prog;

	/* Default is set to 8ms */
#define DEFAULT_PRB_RETIRE_TOV	(8)

	unsigned short  retire_blk_tov;
	unsigned short  version;
	unsigned long	tov_in_jiffies;

	/* timer to retire an outstanding block */
	struct timer_list retire_blk_timer;
};

struct pgv {
	char *buffer;
};

struct packet_ring_buffer {
	struct pgv		*pg_vec;

	unsigned int		head;
	unsigned int		frames_per_block;
	unsigned int		frame_size;
	unsigned int		frame_max;

	unsigned int		pg_vec_order;
	unsigned int		pg_vec_pages;
	unsigned int		pg_vec_len;

	unsigned int __percpu	*pending_refcnt;

	struct tpacket_kbdq_core	prb_bdqc;
};

extern struct mutex fanout_mutex;
#define PACKET_FANOUT_MAX	256

struct packet_fanout {
	possible_net_t		net;
	unsigned int		num_members;
	u16			id;
	u8			type;
	u8			flags;
	union {
		atomic_t		rr_cur;
		struct bpf_prog __rcu	*bpf_prog;
	};
	struct list_head	list;
	struct sock		*arr[PACKET_FANOUT_MAX];
	spinlock_t		lock;
	refcount_t		sk_ref;
	struct packet_type	prot_hook ____cacheline_aligned_in_smp;
};

struct packet_rollover {
	int			sock;
	atomic_long_t		num;
	atomic_long_t		num_huge;
	atomic_long_t		num_failed;
#define ROLLOVER_HLEN	(L1_CACHE_BYTES / sizeof(u32))
	u32			history[ROLLOVER_HLEN] ____cacheline_aligned;
} ____cacheline_aligned_in_smp;

struct packet_sock {
	/* struct sock has to be the first member of packet_sock */
	struct sock		sk;
	struct packet_fanout	*fanout;
	union  tpacket_stats_u	stats;
	struct packet_ring_buffer	rx_ring;
	struct packet_ring_buffer	tx_ring;
	int			copy_thresh;
	spinlock_t		bind_lock;
	struct mutex		pg_vec_lock;
	unsigned int		running;	/* bind_lock must be held */
	unsigned int		auxdata:1,	/* writer must hold sock lock */
				origdev:1,
				has_vnet_hdr:1,
				tp_loss:1,
				tp_tx_has_off:1;
	int			pressure;
	int			ifindex;	/* bound device		*/
	__be16			num;
	struct packet_rollover	*rollover;
	struct packet_mclist	*mclist;
	atomic_t		mapped;
	enum tpacket_versions	tp_version;
	unsigned int		tp_hdrlen;
	unsigned int		tp_reserve;
	unsigned int		tp_tstamp;
	struct net_device __rcu	*cached_dev;
	int			(*xmit)(struct sk_buff *skb);
	struct packet_type	prot_hook ____cacheline_aligned_in_smp;
};

static struct packet_sock *pkt_sk(struct sock *sk)
{
	return (struct packet_sock *)sk;
}

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
2787b04b PE	2	#ifndef __PACKET_INTERNAL_H__
	3	#define __PACKET_INTERNAL_H__
	4
fb5c2c17 RE	5	#include <linux/refcount.h>
fb5c2c17 RE	6
2787b04b PE	7	struct packet_mclist {
	8	struct packet_mclist *next;
	9	int ifindex;
	10	int count;
	11	unsigned short type;
	12	unsigned short alen;
	13	unsigned char addr[MAX_ADDR_LEN];
	14	};
	15
	16	/* kbdq - kernel block descriptor queue */
	17	struct tpacket_kbdq_core {
	18	struct pgv *pkbdq;
	19	unsigned int feature_req_word;
	20	unsigned int hdrlen;
	21	unsigned char reset_pending_on_curr_blk;
	22	unsigned char delete_blk_timer;
	23	unsigned short kactive_blk_num;
	24	unsigned short blk_sizeof_priv;
	25
	26	/* last_kactive_blk_num:
	27	* trick to see if user-space has caught up
	28	* in order to avoid refreshing timer when every single pkt arrives.
	29	*/
	30	unsigned short last_kactive_blk_num;
	31
	32	char *pkblk_start;
	33	char *pkblk_end;
	34	int kblk_size;
dc808110	35	unsigned int max_frame_len;
2787b04b PE	36	unsigned int knum_blocks;
	37	uint64_t knxt_seq_num;
	38	char *prev;
	39	char *nxt_offset;
	40	struct sk_buff *skb;
	41
	42	atomic_t blk_fill_in_prog;
	43
	44	/* Default is set to 8ms */
	45	#define DEFAULT_PRB_RETIRE_TOV (8)
	46
	47	unsigned short retire_blk_tov;
	48	unsigned short version;
	49	unsigned long tov_in_jiffies;
	50
	51	/* timer to retire an outstanding block */
	52	struct timer_list retire_blk_timer;
	53	};
	54
	55	struct pgv {
	56	char *buffer;
	57	};
	58
	59	struct packet_ring_buffer {
	60	struct pgv *pg_vec;
0578edc5	61
2787b04b PE	62	unsigned int head;
	63	unsigned int frames_per_block;
	64	unsigned int frame_size;
	65	unsigned int frame_max;
	66
	67	unsigned int pg_vec_order;
	68	unsigned int pg_vec_pages;
	69	unsigned int pg_vec_len;
	70
b0138408	71	unsigned int __percpu *pending_refcnt;
0578edc5 DB	72
0578edc5 DB	73	struct tpacket_kbdq_core prb_bdqc;
2787b04b PE	74	};
2787b04b PE	75
fff3321d PE	76	extern struct mutex fanout_mutex;
	77	#define PACKET_FANOUT_MAX 256
	78
	79	struct packet_fanout {
0c5c9fb5	80	possible_net_t net;
fff3321d PE	81	unsigned int num_members;
	82	u16 id;
	83	u8 type;
77f65ebd	84	u8 flags;
47dceb8e WB	85	union {
	86	atomic_t rr_cur;
	87	struct bpf_prog __rcu *bpf_prog;
	88	};
fff3321d PE	89	struct list_head list;
	90	struct sock *arr[PACKET_FANOUT_MAX];
	91	spinlock_t lock;
fb5c2c17	92	refcount_t sk_ref;
fff3321d PE	93	struct packet_type prot_hook ____cacheline_aligned_in_smp;
	94	};
	95
0648ab70 WB	96	struct packet_rollover {
0648ab70 WB	97	int sock;
a9b63918 WB	98	atomic_long_t num;
	99	atomic_long_t num_huge;
	100	atomic_long_t num_failed;
3b3a5b0a WB	101	#define ROLLOVER_HLEN (L1_CACHE_BYTES / sizeof(u32))
3b3a5b0a WB	102	u32 history[ROLLOVER_HLEN] ____cacheline_aligned;
0648ab70 WB	103	} ____cacheline_aligned_in_smp;
0648ab70 WB	104
2787b04b PE	105	struct packet_sock {
	106	/* struct sock has to be the first member of packet_sock */
	107	struct sock sk;
	108	struct packet_fanout *fanout;
ee80fbf3	109	union tpacket_stats_u stats;
2787b04b PE	110	struct packet_ring_buffer rx_ring;
	111	struct packet_ring_buffer tx_ring;
	112	int copy_thresh;
	113	spinlock_t bind_lock;
	114	struct mutex pg_vec_lock;
e3ff69f6 WB	115	unsigned int running; /* bind_lock must be held */
e3ff69f6 WB	116	unsigned int auxdata:1, /* writer must hold sock lock */
2787b04b	117	origdev:1,
e3ff69f6 WB	118	has_vnet_hdr:1,
	119	tp_loss:1,
	120	tp_tx_has_off:1;
2ccdbaa6	121	int pressure;
2787b04b PE	122	int ifindex; /* bound device */
2787b04b PE	123	__be16 num;
0648ab70	124	struct packet_rollover *rollover;
2787b04b PE	125	struct packet_mclist *mclist;
	126	atomic_t mapped;
	127	enum tpacket_versions tp_version;
	128	unsigned int tp_hdrlen;
	129	unsigned int tp_reserve;
2787b04b	130	unsigned int tp_tstamp;
e40526cb	131	struct net_device __rcu *cached_dev;
d346a3fa	132	int (xmit)(struct sk_buff skb);
2787b04b PE	133	struct packet_type prot_hook ____cacheline_aligned_in_smp;
	134	};
	135
	136	static struct packet_sock pkt_sk(struct sock sk)
	137	{
	138	return (struct packet_sock *)sk;
	139	}
	140
	141	#endif