xref: /linux/drivers/net/netdevsim/netdevsim.h (revision d4b996f9ef1fe83d9ce9ad5c1ca0bd8231638ce5)
1 /*
2  * Copyright (C) 2017 Netronome Systems, Inc.
3  *
4  * This software is licensed under the GNU General License Version 2,
5  * June 1991 as shown in the file COPYING in the top-level directory of this
6  * source tree.
7  *
8  * THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
9  * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
10  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
11  * FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
12  * OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
13  * THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
14  */
15 
16 #include <linux/debugfs.h>
17 #include <linux/device.h>
18 #include <linux/ethtool.h>
19 #include <linux/kernel.h>
20 #include <linux/list.h>
21 #include <linux/netdevice.h>
22 #include <linux/u64_stats_sync.h>
23 #include <net/devlink.h>
24 #include <net/udp_tunnel.h>
25 #include <net/xdp.h>
26 
27 #define DRV_NAME	"netdevsim"
28 
29 #define NSIM_XDP_MAX_MTU	4000
30 
31 #define NSIM_EA(extack, msg)	NL_SET_ERR_MSG_MOD((extack), msg)
32 
33 #define NSIM_IPSEC_MAX_SA_COUNT		33
34 #define NSIM_IPSEC_VALID		BIT(31)
35 #define NSIM_UDP_TUNNEL_N_PORTS		4
36 
37 struct nsim_sa {
38 	struct xfrm_state *xs;
39 	__be32 ipaddr[4];
40 	u32 key[4];
41 	u32 salt;
42 	bool used;
43 	bool crypt;
44 	bool rx;
45 };
46 
47 struct nsim_ipsec {
48 	struct nsim_sa sa[NSIM_IPSEC_MAX_SA_COUNT];
49 	struct dentry *pfile;
50 	u32 count;
51 	u32 tx;
52 	u32 ok;
53 };
54 
55 struct nsim_ethtool_pauseparam {
56 	bool rx;
57 	bool tx;
58 	bool report_stats_rx;
59 	bool report_stats_tx;
60 };
61 
62 struct nsim_ethtool {
63 	u32 get_err;
64 	u32 set_err;
65 	struct nsim_ethtool_pauseparam pauseparam;
66 	struct ethtool_coalesce coalesce;
67 	struct ethtool_ringparam ring;
68 	struct ethtool_fecparam fec;
69 };
70 
71 struct netdevsim {
72 	struct net_device *netdev;
73 	struct nsim_dev *nsim_dev;
74 	struct nsim_dev_port *nsim_dev_port;
75 
76 	u64 tx_packets;
77 	u64 tx_bytes;
78 	struct u64_stats_sync syncp;
79 
80 	struct nsim_bus_dev *nsim_bus_dev;
81 
82 	struct bpf_prog	*bpf_offloaded;
83 	u32 bpf_offloaded_id;
84 
85 	struct xdp_attachment_info xdp;
86 	struct xdp_attachment_info xdp_hw;
87 
88 	bool bpf_tc_accept;
89 	bool bpf_tc_non_bound_accept;
90 	bool bpf_xdpdrv_accept;
91 	bool bpf_xdpoffload_accept;
92 
93 	bool bpf_map_accept;
94 	struct nsim_ipsec ipsec;
95 	struct {
96 		u32 inject_error;
97 		u32 sleep;
98 		u32 __ports[2][NSIM_UDP_TUNNEL_N_PORTS];
99 		u32 (*ports)[NSIM_UDP_TUNNEL_N_PORTS];
100 		struct debugfs_u32_array dfs_ports[2];
101 	} udp_ports;
102 
103 	struct nsim_ethtool ethtool;
104 };
105 
106 struct netdevsim *
107 nsim_create(struct nsim_dev *nsim_dev, struct nsim_dev_port *nsim_dev_port);
108 void nsim_destroy(struct netdevsim *ns);
109 
110 void nsim_ethtool_init(struct netdevsim *ns);
111 
112 void nsim_udp_tunnels_debugfs_create(struct nsim_dev *nsim_dev);
113 int nsim_udp_tunnels_info_create(struct nsim_dev *nsim_dev,
114 				 struct net_device *dev);
115 void nsim_udp_tunnels_info_destroy(struct net_device *dev);
116 
117 #ifdef CONFIG_BPF_SYSCALL
118 int nsim_bpf_dev_init(struct nsim_dev *nsim_dev);
119 void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev);
120 int nsim_bpf_init(struct netdevsim *ns);
121 void nsim_bpf_uninit(struct netdevsim *ns);
122 int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf);
123 int nsim_bpf_disable_tc(struct netdevsim *ns);
124 int nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,
125 			       void *type_data, void *cb_priv);
126 #else
127 
128 static inline int nsim_bpf_dev_init(struct nsim_dev *nsim_dev)
129 {
130 	return 0;
131 }
132 
133 static inline void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev)
134 {
135 }
136 static inline int nsim_bpf_init(struct netdevsim *ns)
137 {
138 	return 0;
139 }
140 
141 static inline void nsim_bpf_uninit(struct netdevsim *ns)
142 {
143 }
144 
145 static inline int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf)
146 {
147 	return -EOPNOTSUPP;
148 }
149 
150 static inline int nsim_bpf_disable_tc(struct netdevsim *ns)
151 {
152 	return 0;
153 }
154 
155 static inline int
156 nsim_bpf_setup_tc_block_cb(enum tc_setup_type type, void *type_data,
157 			   void *cb_priv)
158 {
159 	return -EOPNOTSUPP;
160 }
161 #endif
162 
163 enum nsim_resource_id {
164 	NSIM_RESOURCE_NONE,   /* DEVLINK_RESOURCE_ID_PARENT_TOP */
165 	NSIM_RESOURCE_IPV4,
166 	NSIM_RESOURCE_IPV4_FIB,
167 	NSIM_RESOURCE_IPV4_FIB_RULES,
168 	NSIM_RESOURCE_IPV6,
169 	NSIM_RESOURCE_IPV6_FIB,
170 	NSIM_RESOURCE_IPV6_FIB_RULES,
171 	NSIM_RESOURCE_NEXTHOPS,
172 };
173 
174 struct nsim_dev_health {
175 	struct devlink_health_reporter *empty_reporter;
176 	struct devlink_health_reporter *dummy_reporter;
177 	struct dentry *ddir;
178 	char *recovered_break_msg;
179 	u32 binary_len;
180 	bool fail_recover;
181 };
182 
183 int nsim_dev_health_init(struct nsim_dev *nsim_dev, struct devlink *devlink);
184 void nsim_dev_health_exit(struct nsim_dev *nsim_dev);
185 
186 #if IS_ENABLED(CONFIG_PSAMPLE)
187 int nsim_dev_psample_init(struct nsim_dev *nsim_dev);
188 void nsim_dev_psample_exit(struct nsim_dev *nsim_dev);
189 #else
190 static inline int nsim_dev_psample_init(struct nsim_dev *nsim_dev)
191 {
192 	return 0;
193 }
194 
195 static inline void nsim_dev_psample_exit(struct nsim_dev *nsim_dev)
196 {
197 }
198 #endif
199 
200 enum nsim_dev_port_type {
201 	NSIM_DEV_PORT_TYPE_PF,
202 	NSIM_DEV_PORT_TYPE_VF,
203 };
204 
205 #define NSIM_DEV_VF_PORT_INDEX_BASE 128
206 #define NSIM_DEV_VF_PORT_INDEX_MAX UINT_MAX
207 
208 struct nsim_dev_port {
209 	struct list_head list;
210 	struct devlink_port devlink_port;
211 	unsigned int port_index;
212 	enum nsim_dev_port_type port_type;
213 	struct dentry *ddir;
214 	struct dentry *rate_parent;
215 	char *parent_name;
216 	struct netdevsim *ns;
217 };
218 
219 struct nsim_dev {
220 	struct nsim_bus_dev *nsim_bus_dev;
221 	struct nsim_fib_data *fib_data;
222 	struct nsim_trap_data *trap_data;
223 	struct dentry *ddir;
224 	struct dentry *ports_ddir;
225 	struct dentry *take_snapshot;
226 	struct dentry *max_vfs;
227 	struct dentry *nodes_ddir;
228 	struct bpf_offload_dev *bpf_dev;
229 	bool bpf_bind_accept;
230 	bool bpf_bind_verifier_accept;
231 	u32 bpf_bind_verifier_delay;
232 	struct dentry *ddir_bpf_bound_progs;
233 	u32 prog_id_gen;
234 	struct list_head bpf_bound_progs;
235 	struct list_head bpf_bound_maps;
236 	struct netdev_phys_item_id switch_id;
237 	struct list_head port_list;
238 	struct mutex port_list_lock; /* protects port list */
239 	bool fw_update_status;
240 	u32 fw_update_overwrite_mask;
241 	u32 max_macs;
242 	bool test1;
243 	bool dont_allow_reload;
244 	bool fail_reload;
245 	struct devlink_region *dummy_region;
246 	struct nsim_dev_health health;
247 	struct flow_action_cookie *fa_cookie;
248 	spinlock_t fa_cookie_lock; /* protects fa_cookie */
249 	bool fail_trap_group_set;
250 	bool fail_trap_policer_set;
251 	bool fail_trap_policer_counter_get;
252 	bool fail_trap_drop_counter_get;
253 	struct {
254 		struct udp_tunnel_nic_shared utn_shared;
255 		u32 __ports[2][NSIM_UDP_TUNNEL_N_PORTS];
256 		bool sync_all;
257 		bool open_only;
258 		bool ipv4_only;
259 		bool shared;
260 		bool static_iana_vxlan;
261 		u32 sleep;
262 	} udp_ports;
263 	struct nsim_dev_psample *psample;
264 	u16 esw_mode;
265 };
266 
267 int nsim_esw_legacy_enable(struct nsim_dev *nsim_dev, struct netlink_ext_ack *extack);
268 int nsim_esw_switchdev_enable(struct nsim_dev *nsim_dev, struct netlink_ext_ack *extack);
269 
270 static inline bool nsim_esw_mode_is_legacy(struct nsim_dev *nsim_dev)
271 {
272 	return nsim_dev->esw_mode == DEVLINK_ESWITCH_MODE_LEGACY;
273 }
274 
275 static inline bool nsim_esw_mode_is_switchdev(struct nsim_dev *nsim_dev)
276 {
277 	return nsim_dev->esw_mode == DEVLINK_ESWITCH_MODE_SWITCHDEV;
278 }
279 
280 static inline struct net *nsim_dev_net(struct nsim_dev *nsim_dev)
281 {
282 	return devlink_net(priv_to_devlink(nsim_dev));
283 }
284 
285 int nsim_dev_init(void);
286 void nsim_dev_exit(void);
287 int nsim_dev_probe(struct nsim_bus_dev *nsim_bus_dev);
288 void nsim_dev_remove(struct nsim_bus_dev *nsim_bus_dev);
289 int nsim_dev_port_add(struct nsim_bus_dev *nsim_bus_dev,
290 		      enum nsim_dev_port_type type,
291 		      unsigned int port_index);
292 int nsim_dev_port_del(struct nsim_bus_dev *nsim_bus_dev,
293 		      enum nsim_dev_port_type type,
294 		      unsigned int port_index);
295 
296 struct nsim_fib_data *nsim_fib_create(struct devlink *devlink,
297 				      struct netlink_ext_ack *extack);
298 void nsim_fib_destroy(struct devlink *devlink, struct nsim_fib_data *fib_data);
299 u64 nsim_fib_get_val(struct nsim_fib_data *fib_data,
300 		     enum nsim_resource_id res_id, bool max);
301 
302 ssize_t nsim_bus_dev_max_vfs_read(struct file *file,
303 				  char __user *data,
304 				  size_t count, loff_t *ppos);
305 ssize_t nsim_bus_dev_max_vfs_write(struct file *file,
306 				   const char __user *data,
307 				   size_t count, loff_t *ppos);
308 void nsim_bus_dev_vfs_disable(struct nsim_bus_dev *nsim_bus_dev);
309 
310 static inline bool nsim_dev_port_is_pf(struct nsim_dev_port *nsim_dev_port)
311 {
312 	return nsim_dev_port->port_type == NSIM_DEV_PORT_TYPE_PF;
313 }
314 
315 static inline bool nsim_dev_port_is_vf(struct nsim_dev_port *nsim_dev_port)
316 {
317 	return nsim_dev_port->port_type == NSIM_DEV_PORT_TYPE_VF;
318 }
319 #if IS_ENABLED(CONFIG_XFRM_OFFLOAD)
320 void nsim_ipsec_init(struct netdevsim *ns);
321 void nsim_ipsec_teardown(struct netdevsim *ns);
322 bool nsim_ipsec_tx(struct netdevsim *ns, struct sk_buff *skb);
323 #else
324 static inline void nsim_ipsec_init(struct netdevsim *ns)
325 {
326 }
327 
328 static inline void nsim_ipsec_teardown(struct netdevsim *ns)
329 {
330 }
331 
332 static inline bool nsim_ipsec_tx(struct netdevsim *ns, struct sk_buff *skb)
333 {
334 	return true;
335 }
336 #endif
337 
338 struct nsim_vf_config {
339 	int link_state;
340 	u16 min_tx_rate;
341 	u16 max_tx_rate;
342 	u16 vlan;
343 	__be16 vlan_proto;
344 	u16 qos;
345 	u8 vf_mac[ETH_ALEN];
346 	bool spoofchk_enabled;
347 	bool trusted;
348 	bool rss_query_enabled;
349 };
350 
351 struct nsim_bus_dev {
352 	struct device dev;
353 	struct list_head list;
354 	unsigned int port_count;
355 	unsigned int num_queues; /* Number of queues for each port on this bus */
356 	struct net *initial_net; /* Purpose of this is to carry net pointer
357 				  * during the probe time only.
358 				  */
359 	unsigned int max_vfs;
360 	unsigned int num_vfs;
361 	struct mutex vfs_lock;  /* Protects vfconfigs */
362 	struct nsim_vf_config *vfconfigs;
363 	/* Lock for devlink->reload_enabled in netdevsim module */
364 	struct mutex nsim_bus_reload_lock;
365 	bool init;
366 };
367 
368 int nsim_bus_init(void);
369 void nsim_bus_exit(void);
370