xref: /linux/drivers/net/netdevsim/netdevsim.h (revision 3d2c3d2eea9acdbee5b5742d15d021069b49d3f9)
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/ethtool_netlink.h>
20 #include <linux/kernel.h>
21 #include <linux/list.h>
22 #include <linux/netdevice.h>
23 #include <linux/ptp_mock.h>
24 #include <linux/u64_stats_sync.h>
25 #include <net/devlink.h>
26 #include <net/udp_tunnel.h>
27 #include <net/xdp.h>
28 #include <net/macsec.h>
29 
30 #define DRV_NAME	"netdevsim"
31 
32 #define NSIM_XDP_MAX_MTU	4000
33 
34 #define NSIM_EA(extack, msg)	NL_SET_ERR_MSG_MOD((extack), msg)
35 
36 #define NSIM_IPSEC_MAX_SA_COUNT		33
37 #define NSIM_IPSEC_VALID		BIT(31)
38 #define NSIM_UDP_TUNNEL_N_PORTS		4
39 
40 #define NSIM_HDS_THRESHOLD_MAX		1024
41 
42 struct nsim_sa {
43 	struct xfrm_state *xs;
44 	__be32 ipaddr[4];
45 	u32 key[4];
46 	u32 salt;
47 	bool used;
48 	bool crypt;
49 	bool rx;
50 };
51 
52 struct nsim_ipsec {
53 	struct nsim_sa sa[NSIM_IPSEC_MAX_SA_COUNT];
54 	struct dentry *pfile;
55 	u32 count;
56 	u32 tx;
57 };
58 
59 #define NSIM_MACSEC_MAX_SECY_COUNT 3
60 #define NSIM_MACSEC_MAX_RXSC_COUNT 1
61 struct nsim_rxsc {
62 	sci_t sci;
63 	bool used;
64 };
65 
66 struct nsim_secy {
67 	sci_t sci;
68 	struct nsim_rxsc nsim_rxsc[NSIM_MACSEC_MAX_RXSC_COUNT];
69 	u8 nsim_rxsc_count;
70 	bool used;
71 };
72 
73 struct nsim_macsec {
74 	struct nsim_secy nsim_secy[NSIM_MACSEC_MAX_SECY_COUNT];
75 	u8 nsim_secy_count;
76 };
77 
78 struct nsim_ethtool_pauseparam {
79 	bool rx;
80 	bool tx;
81 	bool report_stats_rx;
82 	bool report_stats_tx;
83 };
84 
85 struct nsim_ethtool {
86 	u32 get_err;
87 	u32 set_err;
88 	u32 channels;
89 	struct nsim_ethtool_pauseparam pauseparam;
90 	struct ethtool_coalesce coalesce;
91 	struct ethtool_ringparam ring;
92 	struct ethtool_fecparam fec;
93 };
94 
95 struct nsim_rq {
96 	struct napi_struct napi;
97 	struct sk_buff_head skb_queue;
98 	struct page_pool *page_pool;
99 	struct hrtimer napi_timer;
100 };
101 
102 struct netdevsim {
103 	struct net_device *netdev;
104 	struct nsim_dev *nsim_dev;
105 	struct nsim_dev_port *nsim_dev_port;
106 	struct mock_phc *phc;
107 	struct nsim_rq **rq;
108 
109 	int rq_reset_mode;
110 
111 	struct {
112 		u64_stats_t rx_packets;
113 		u64_stats_t rx_bytes;
114 		u64_stats_t tx_packets;
115 		u64_stats_t tx_bytes;
116 		struct u64_stats_sync syncp;
117 		struct psp_dev *dev;
118 		u32 spi;
119 		u32 assoc_cnt;
120 	} psp;
121 
122 	struct nsim_bus_dev *nsim_bus_dev;
123 
124 	struct bpf_prog	*bpf_offloaded;
125 	u32 bpf_offloaded_id;
126 
127 	struct xdp_attachment_info xdp;
128 	struct xdp_attachment_info xdp_hw;
129 
130 	bool bpf_tc_accept;
131 	bool bpf_tc_non_bound_accept;
132 	bool bpf_xdpdrv_accept;
133 	bool bpf_xdpoffload_accept;
134 
135 	bool bpf_map_accept;
136 	struct nsim_ipsec ipsec;
137 	struct nsim_macsec macsec;
138 	struct {
139 		u32 inject_error;
140 		u32 __ports[2][NSIM_UDP_TUNNEL_N_PORTS];
141 		u32 (*ports)[NSIM_UDP_TUNNEL_N_PORTS];
142 		struct dentry *ddir;
143 		struct debugfs_u32_array dfs_ports[2];
144 	} udp_ports;
145 
146 	struct page *page;
147 	struct dentry *pp_dfs;
148 	struct dentry *qr_dfs;
149 
150 	struct nsim_ethtool ethtool;
151 	struct netdevsim __rcu *peer;
152 
153 	struct notifier_block nb;
154 	struct netdev_net_notifier nn;
155 };
156 
157 struct netdevsim *nsim_create(struct nsim_dev *nsim_dev,
158 			      struct nsim_dev_port *nsim_dev_port,
159 			      u8 perm_addr[ETH_ALEN]);
160 void nsim_destroy(struct netdevsim *ns);
161 bool netdev_is_nsim(struct net_device *dev);
162 
163 void nsim_ethtool_init(struct netdevsim *ns);
164 
165 void nsim_udp_tunnels_debugfs_create(struct nsim_dev *nsim_dev);
166 int nsim_udp_tunnels_info_create(struct nsim_dev *nsim_dev,
167 				 struct net_device *dev);
168 void nsim_udp_tunnels_info_destroy(struct net_device *dev);
169 
170 #ifdef CONFIG_BPF_SYSCALL
171 int nsim_bpf_dev_init(struct nsim_dev *nsim_dev);
172 void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev);
173 int nsim_bpf_init(struct netdevsim *ns);
174 void nsim_bpf_uninit(struct netdevsim *ns);
175 int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf);
176 int nsim_bpf_disable_tc(struct netdevsim *ns);
177 int nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,
178 			       void *type_data, void *cb_priv);
179 #else
180 
181 static inline int nsim_bpf_dev_init(struct nsim_dev *nsim_dev)
182 {
183 	return 0;
184 }
185 
186 static inline void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev)
187 {
188 }
189 static inline int nsim_bpf_init(struct netdevsim *ns)
190 {
191 	return 0;
192 }
193 
194 static inline void nsim_bpf_uninit(struct netdevsim *ns)
195 {
196 }
197 
198 static inline int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf)
199 {
200 	return -EOPNOTSUPP;
201 }
202 
203 static inline int nsim_bpf_disable_tc(struct netdevsim *ns)
204 {
205 	return 0;
206 }
207 
208 static inline int
209 nsim_bpf_setup_tc_block_cb(enum tc_setup_type type, void *type_data,
210 			   void *cb_priv)
211 {
212 	return -EOPNOTSUPP;
213 }
214 #endif
215 
216 enum nsim_resource_id {
217 	NSIM_RESOURCE_NONE,   /* DEVLINK_RESOURCE_ID_PARENT_TOP */
218 	NSIM_RESOURCE_IPV4,
219 	NSIM_RESOURCE_IPV4_FIB,
220 	NSIM_RESOURCE_IPV4_FIB_RULES,
221 	NSIM_RESOURCE_IPV6,
222 	NSIM_RESOURCE_IPV6_FIB,
223 	NSIM_RESOURCE_IPV6_FIB_RULES,
224 	NSIM_RESOURCE_NEXTHOPS,
225 };
226 
227 enum nsim_port_resource_id {
228 	NSIM_PORT_RESOURCE_TEST = 1,
229 };
230 
231 struct nsim_dev_health {
232 	struct devlink_health_reporter *empty_reporter;
233 	struct devlink_health_reporter *dummy_reporter;
234 	struct dentry *ddir;
235 	char *recovered_break_msg;
236 	u32 binary_len;
237 	bool fail_recover;
238 };
239 
240 int nsim_dev_health_init(struct nsim_dev *nsim_dev, struct devlink *devlink);
241 void nsim_dev_health_exit(struct nsim_dev *nsim_dev);
242 
243 struct nsim_dev_hwstats_netdev {
244 	struct list_head list;
245 	struct net_device *netdev;
246 	struct rtnl_hw_stats64 stats;
247 	bool enabled;
248 	bool fail_enable;
249 };
250 
251 struct nsim_dev_hwstats {
252 	struct dentry *ddir;
253 	struct dentry *l3_ddir;
254 
255 	struct mutex hwsdev_list_lock; /* protects hwsdev list(s) */
256 	struct list_head l3_list;
257 
258 	struct notifier_block netdevice_nb;
259 	struct delayed_work traffic_dw;
260 };
261 
262 int nsim_dev_hwstats_init(struct nsim_dev *nsim_dev);
263 void nsim_dev_hwstats_exit(struct nsim_dev *nsim_dev);
264 
265 #if IS_ENABLED(CONFIG_PSAMPLE)
266 int nsim_dev_psample_init(struct nsim_dev *nsim_dev);
267 void nsim_dev_psample_exit(struct nsim_dev *nsim_dev);
268 #else
269 static inline int nsim_dev_psample_init(struct nsim_dev *nsim_dev)
270 {
271 	return 0;
272 }
273 
274 static inline void nsim_dev_psample_exit(struct nsim_dev *nsim_dev)
275 {
276 }
277 #endif
278 
279 enum nsim_dev_port_type {
280 	NSIM_DEV_PORT_TYPE_PF,
281 	NSIM_DEV_PORT_TYPE_VF,
282 };
283 
284 #define NSIM_DEV_VF_PORT_INDEX_BASE 128
285 #define NSIM_DEV_VF_PORT_INDEX_MAX UINT_MAX
286 
287 struct nsim_dev_port {
288 	struct list_head list;
289 	struct devlink_port devlink_port;
290 	unsigned int port_index;
291 	enum nsim_dev_port_type port_type;
292 	struct dentry *ddir;
293 	struct dentry *rate_parent;
294 	char *parent_name;
295 	u32 tc_bw[DEVLINK_RATE_TCS_MAX];
296 	struct netdevsim *ns;
297 };
298 
299 struct nsim_vf_config {
300 	int link_state;
301 	u16 min_tx_rate;
302 	u16 max_tx_rate;
303 	u16 vlan;
304 	__be16 vlan_proto;
305 	u16 qos;
306 	u8 vf_mac[ETH_ALEN];
307 	bool spoofchk_enabled;
308 	bool trusted;
309 	bool rss_query_enabled;
310 };
311 
312 struct nsim_dev {
313 	struct nsim_bus_dev *nsim_bus_dev;
314 	struct nsim_fib_data *fib_data;
315 	struct nsim_trap_data *trap_data;
316 	struct dentry *ddir;
317 	struct dentry *ports_ddir;
318 	struct dentry *take_snapshot;
319 	struct dentry *nodes_ddir;
320 
321 	struct nsim_vf_config *vfconfigs;
322 
323 	struct bpf_offload_dev *bpf_dev;
324 	bool bpf_bind_accept;
325 	bool bpf_bind_verifier_accept;
326 	u32 bpf_bind_verifier_delay;
327 	struct dentry *ddir_bpf_bound_progs;
328 	u32 prog_id_gen;
329 	struct list_head bpf_bound_progs;
330 	struct list_head bpf_bound_maps;
331 	struct mutex progs_list_lock;
332 	struct netdev_phys_item_id switch_id;
333 	struct list_head port_list;
334 	bool fw_update_status;
335 	u32 fw_update_overwrite_mask;
336 	u32 fw_update_flash_chunk_time_ms;
337 	u32 max_macs;
338 	bool test1;
339 	u32 test2;
340 	bool dont_allow_reload;
341 	bool fail_reload;
342 	struct devlink_region *dummy_region;
343 	struct nsim_dev_health health;
344 	struct nsim_dev_hwstats hwstats;
345 	struct flow_action_cookie *fa_cookie;
346 	spinlock_t fa_cookie_lock; /* protects fa_cookie */
347 	bool fail_trap_group_set;
348 	bool fail_trap_policer_set;
349 	bool fail_trap_policer_counter_get;
350 	bool fail_trap_drop_counter_get;
351 	struct {
352 		struct udp_tunnel_nic_shared utn_shared;
353 		u32 __ports[2][NSIM_UDP_TUNNEL_N_PORTS];
354 		bool sync_all;
355 		bool open_only;
356 		bool ipv4_only;
357 		bool shared;
358 		bool static_iana_vxlan;
359 	} udp_ports;
360 	struct nsim_dev_psample *psample;
361 	u16 esw_mode;
362 };
363 
364 static inline bool nsim_esw_mode_is_legacy(struct nsim_dev *nsim_dev)
365 {
366 	return nsim_dev->esw_mode == DEVLINK_ESWITCH_MODE_LEGACY;
367 }
368 
369 static inline bool nsim_esw_mode_is_switchdev(struct nsim_dev *nsim_dev)
370 {
371 	return nsim_dev->esw_mode == DEVLINK_ESWITCH_MODE_SWITCHDEV;
372 }
373 
374 static inline struct net *nsim_dev_net(struct nsim_dev *nsim_dev)
375 {
376 	return devlink_net(priv_to_devlink(nsim_dev));
377 }
378 
379 int nsim_dev_init(void);
380 void nsim_dev_exit(void);
381 int nsim_drv_probe(struct nsim_bus_dev *nsim_bus_dev);
382 void nsim_drv_remove(struct nsim_bus_dev *nsim_bus_dev);
383 int nsim_drv_port_add(struct nsim_bus_dev *nsim_bus_dev,
384 		      enum nsim_dev_port_type type, unsigned int port_index,
385 		      u8 perm_addr[ETH_ALEN]);
386 int nsim_drv_port_del(struct nsim_bus_dev *nsim_bus_dev,
387 		      enum nsim_dev_port_type type,
388 		      unsigned int port_index);
389 int nsim_drv_configure_vfs(struct nsim_bus_dev *nsim_bus_dev,
390 			   unsigned int num_vfs);
391 
392 unsigned int nsim_dev_get_vfs(struct nsim_dev *nsim_dev);
393 
394 struct nsim_fib_data *nsim_fib_create(struct devlink *devlink,
395 				      struct netlink_ext_ack *extack);
396 void nsim_fib_destroy(struct devlink *devlink, struct nsim_fib_data *fib_data);
397 u64 nsim_fib_get_val(struct nsim_fib_data *fib_data,
398 		     enum nsim_resource_id res_id, bool max);
399 
400 static inline bool nsim_dev_port_is_pf(struct nsim_dev_port *nsim_dev_port)
401 {
402 	return nsim_dev_port->port_type == NSIM_DEV_PORT_TYPE_PF;
403 }
404 
405 static inline bool nsim_dev_port_is_vf(struct nsim_dev_port *nsim_dev_port)
406 {
407 	return nsim_dev_port->port_type == NSIM_DEV_PORT_TYPE_VF;
408 }
409 #if IS_ENABLED(CONFIG_XFRM_OFFLOAD)
410 void nsim_ipsec_init(struct netdevsim *ns);
411 void nsim_ipsec_teardown(struct netdevsim *ns);
412 bool nsim_ipsec_tx(struct netdevsim *ns, struct sk_buff *skb);
413 #else
414 static inline void nsim_ipsec_init(struct netdevsim *ns)
415 {
416 }
417 
418 static inline void nsim_ipsec_teardown(struct netdevsim *ns)
419 {
420 }
421 
422 static inline bool nsim_ipsec_tx(struct netdevsim *ns, struct sk_buff *skb)
423 {
424 	return true;
425 }
426 #endif
427 
428 #if IS_ENABLED(CONFIG_MACSEC)
429 void nsim_macsec_init(struct netdevsim *ns);
430 void nsim_macsec_teardown(struct netdevsim *ns);
431 #else
432 static inline void nsim_macsec_init(struct netdevsim *ns)
433 {
434 }
435 
436 static inline void nsim_macsec_teardown(struct netdevsim *ns)
437 {
438 }
439 #endif
440 
441 #if IS_ENABLED(CONFIG_INET_PSP)
442 int nsim_psp_init(struct netdevsim *ns);
443 void nsim_psp_uninit(struct netdevsim *ns);
444 void nsim_psp_handle_ext(struct sk_buff *skb, struct skb_ext *psp_ext);
445 enum skb_drop_reason
446 nsim_do_psp(struct sk_buff *skb, struct netdevsim *ns,
447 	    struct netdevsim *peer_ns, struct skb_ext **psp_ext);
448 #else
449 static inline int nsim_psp_init(struct netdevsim *ns) { return 0; }
450 static inline void nsim_psp_uninit(struct netdevsim *ns) {}
451 static inline enum skb_drop_reason
452 nsim_do_psp(struct sk_buff *skb, struct netdevsim *ns,
453 	    struct netdevsim *peer_ns, struct skb_ext **psp_ext)
454 {
455 	return 0;
456 }
457 
458 static inline void
459 nsim_psp_handle_ext(struct sk_buff *skb, struct skb_ext *psp_ext) {}
460 #endif
461 
462 int nsim_setup_tc(struct net_device *dev, enum tc_setup_type type,
463 		  void *type_data);
464 
465 struct nsim_bus_dev {
466 	struct device dev;
467 	struct list_head list;
468 	unsigned int port_count;
469 	unsigned int num_queues; /* Number of queues for each port on this bus */
470 	struct net *initial_net; /* Purpose of this is to carry net pointer
471 				  * during the probe time only.
472 				  */
473 	unsigned int max_vfs;
474 	unsigned int num_vfs;
475 	bool init;
476 };
477 
478 int nsim_bus_init(void);
479 void nsim_bus_exit(void);
480