xref: /openbmc/linux/net/packet/internal.h (revision a99237af)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PACKET_INTERNAL_H__
3 #define __PACKET_INTERNAL_H__
4 
5 #include <linux/refcount.h>
6 
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;
35 	unsigned int	max_frame_len;
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;
61 
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_pages;
68 	unsigned int		pg_vec_len;
69 
70 	unsigned int __percpu	*pending_refcnt;
71 
72 	struct tpacket_kbdq_core	prb_bdqc;
73 };
74 
75 extern struct mutex fanout_mutex;
76 #define PACKET_FANOUT_MAX	256
77 
78 struct packet_fanout {
79 	possible_net_t		net;
80 	unsigned int		num_members;
81 	u16			id;
82 	u8			type;
83 	u8			flags;
84 	union {
85 		atomic_t		rr_cur;
86 		struct bpf_prog __rcu	*bpf_prog;
87 	};
88 	struct list_head	list;
89 	struct sock		*arr[PACKET_FANOUT_MAX];
90 	spinlock_t		lock;
91 	refcount_t		sk_ref;
92 	struct packet_type	prot_hook ____cacheline_aligned_in_smp;
93 };
94 
95 struct packet_rollover {
96 	int			sock;
97 	atomic_long_t		num;
98 	atomic_long_t		num_huge;
99 	atomic_long_t		num_failed;
100 #define ROLLOVER_HLEN	(L1_CACHE_BYTES / sizeof(u32))
101 	u32			history[ROLLOVER_HLEN] ____cacheline_aligned;
102 } ____cacheline_aligned_in_smp;
103 
104 struct packet_sock {
105 	/* struct sock has to be the first member of packet_sock */
106 	struct sock		sk;
107 	struct packet_fanout	*fanout;
108 	union  tpacket_stats_u	stats;
109 	struct packet_ring_buffer	rx_ring;
110 	struct packet_ring_buffer	tx_ring;
111 	int			copy_thresh;
112 	spinlock_t		bind_lock;
113 	struct mutex		pg_vec_lock;
114 	unsigned int		running;	/* bind_lock must be held */
115 	unsigned int		auxdata:1,	/* writer must hold sock lock */
116 				origdev:1,
117 				has_vnet_hdr:1,
118 				tp_loss:1,
119 				tp_tx_has_off:1;
120 	int			pressure;
121 	int			ifindex;	/* bound device		*/
122 	__be16			num;
123 	struct packet_rollover	*rollover;
124 	struct packet_mclist	*mclist;
125 	atomic_t		mapped;
126 	enum tpacket_versions	tp_version;
127 	unsigned int		tp_hdrlen;
128 	unsigned int		tp_reserve;
129 	unsigned int		tp_tstamp;
130 	struct net_device __rcu	*cached_dev;
131 	int			(*xmit)(struct sk_buff *skb);
132 	struct packet_type	prot_hook ____cacheline_aligned_in_smp;
133 };
134 
135 static struct packet_sock *pkt_sk(struct sock *sk)
136 {
137 	return (struct packet_sock *)sk;
138 }
139 
140 #endif
141