xref: /linux/drivers/net/netdevsim/netdevsim.h (revision 61f96e684edd28ca40555ec49ea1555df31ba619)
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 	u64 tx_packets;
112 	u64 tx_bytes;
113 	u64 tx_dropped;
114 	struct u64_stats_sync syncp;
115 
116 	struct nsim_bus_dev *nsim_bus_dev;
117 
118 	struct bpf_prog	*bpf_offloaded;
119 	u32 bpf_offloaded_id;
120 
121 	struct xdp_attachment_info xdp;
122 	struct xdp_attachment_info xdp_hw;
123 
124 	bool bpf_tc_accept;
125 	bool bpf_tc_non_bound_accept;
126 	bool bpf_xdpdrv_accept;
127 	bool bpf_xdpoffload_accept;
128 
129 	bool bpf_map_accept;
130 	struct nsim_ipsec ipsec;
131 	struct nsim_macsec macsec;
132 	struct {
133 		u32 inject_error;
134 		u32 sleep;
135 		u32 __ports[2][NSIM_UDP_TUNNEL_N_PORTS];
136 		u32 (*ports)[NSIM_UDP_TUNNEL_N_PORTS];
137 		struct dentry *ddir;
138 		struct debugfs_u32_array dfs_ports[2];
139 	} udp_ports;
140 
141 	struct page *page;
142 	struct dentry *pp_dfs;
143 	struct dentry *qr_dfs;
144 
145 	struct nsim_ethtool ethtool;
146 	struct netdevsim __rcu *peer;
147 
148 	struct notifier_block nb;
149 	struct netdev_net_notifier nn;
150 };
151 
152 struct netdevsim *
153 nsim_create(struct nsim_dev *nsim_dev, struct nsim_dev_port *nsim_dev_port);
154 void nsim_destroy(struct netdevsim *ns);
155 bool netdev_is_nsim(struct net_device *dev);
156 
157 void nsim_ethtool_init(struct netdevsim *ns);
158 
159 void nsim_udp_tunnels_debugfs_create(struct nsim_dev *nsim_dev);
160 int nsim_udp_tunnels_info_create(struct nsim_dev *nsim_dev,
161 				 struct net_device *dev);
162 void nsim_udp_tunnels_info_destroy(struct net_device *dev);
163 
164 #ifdef CONFIG_BPF_SYSCALL
165 int nsim_bpf_dev_init(struct nsim_dev *nsim_dev);
166 void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev);
167 int nsim_bpf_init(struct netdevsim *ns);
168 void nsim_bpf_uninit(struct netdevsim *ns);
169 int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf);
170 int nsim_bpf_disable_tc(struct netdevsim *ns);
171 int nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,
172 			       void *type_data, void *cb_priv);
173 #else
174 
nsim_bpf_dev_init(struct nsim_dev * nsim_dev)175 static inline int nsim_bpf_dev_init(struct nsim_dev *nsim_dev)
176 {
177 	return 0;
178 }
179 
nsim_bpf_dev_exit(struct nsim_dev * nsim_dev)180 static inline void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev)
181 {
182 }
nsim_bpf_init(struct netdevsim * ns)183 static inline int nsim_bpf_init(struct netdevsim *ns)
184 {
185 	return 0;
186 }
187 
nsim_bpf_uninit(struct netdevsim * ns)188 static inline void nsim_bpf_uninit(struct netdevsim *ns)
189 {
190 }
191 
nsim_bpf(struct net_device * dev,struct netdev_bpf * bpf)192 static inline int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf)
193 {
194 	return -EOPNOTSUPP;
195 }
196 
nsim_bpf_disable_tc(struct netdevsim * ns)197 static inline int nsim_bpf_disable_tc(struct netdevsim *ns)
198 {
199 	return 0;
200 }
201 
202 static inline int
nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,void * type_data,void * cb_priv)203 nsim_bpf_setup_tc_block_cb(enum tc_setup_type type, void *type_data,
204 			   void *cb_priv)
205 {
206 	return -EOPNOTSUPP;
207 }
208 #endif
209 
210 enum nsim_resource_id {
211 	NSIM_RESOURCE_NONE,   /* DEVLINK_RESOURCE_ID_PARENT_TOP */
212 	NSIM_RESOURCE_IPV4,
213 	NSIM_RESOURCE_IPV4_FIB,
214 	NSIM_RESOURCE_IPV4_FIB_RULES,
215 	NSIM_RESOURCE_IPV6,
216 	NSIM_RESOURCE_IPV6_FIB,
217 	NSIM_RESOURCE_IPV6_FIB_RULES,
218 	NSIM_RESOURCE_NEXTHOPS,
219 };
220 
221 struct nsim_dev_health {
222 	struct devlink_health_reporter *empty_reporter;
223 	struct devlink_health_reporter *dummy_reporter;
224 	struct dentry *ddir;
225 	char *recovered_break_msg;
226 	u32 binary_len;
227 	bool fail_recover;
228 };
229 
230 int nsim_dev_health_init(struct nsim_dev *nsim_dev, struct devlink *devlink);
231 void nsim_dev_health_exit(struct nsim_dev *nsim_dev);
232 
233 struct nsim_dev_hwstats_netdev {
234 	struct list_head list;
235 	struct net_device *netdev;
236 	struct rtnl_hw_stats64 stats;
237 	bool enabled;
238 	bool fail_enable;
239 };
240 
241 struct nsim_dev_hwstats {
242 	struct dentry *ddir;
243 	struct dentry *l3_ddir;
244 
245 	struct mutex hwsdev_list_lock; /* protects hwsdev list(s) */
246 	struct list_head l3_list;
247 
248 	struct notifier_block netdevice_nb;
249 	struct delayed_work traffic_dw;
250 };
251 
252 int nsim_dev_hwstats_init(struct nsim_dev *nsim_dev);
253 void nsim_dev_hwstats_exit(struct nsim_dev *nsim_dev);
254 
255 #if IS_ENABLED(CONFIG_PSAMPLE)
256 int nsim_dev_psample_init(struct nsim_dev *nsim_dev);
257 void nsim_dev_psample_exit(struct nsim_dev *nsim_dev);
258 #else
nsim_dev_psample_init(struct nsim_dev * nsim_dev)259 static inline int nsim_dev_psample_init(struct nsim_dev *nsim_dev)
260 {
261 	return 0;
262 }
263 
nsim_dev_psample_exit(struct nsim_dev * nsim_dev)264 static inline void nsim_dev_psample_exit(struct nsim_dev *nsim_dev)
265 {
266 }
267 #endif
268 
269 enum nsim_dev_port_type {
270 	NSIM_DEV_PORT_TYPE_PF,
271 	NSIM_DEV_PORT_TYPE_VF,
272 };
273 
274 #define NSIM_DEV_VF_PORT_INDEX_BASE 128
275 #define NSIM_DEV_VF_PORT_INDEX_MAX UINT_MAX
276 
277 struct nsim_dev_port {
278 	struct list_head list;
279 	struct devlink_port devlink_port;
280 	unsigned int port_index;
281 	enum nsim_dev_port_type port_type;
282 	struct dentry *ddir;
283 	struct dentry *rate_parent;
284 	char *parent_name;
285 	struct netdevsim *ns;
286 };
287 
288 struct nsim_vf_config {
289 	int link_state;
290 	u16 min_tx_rate;
291 	u16 max_tx_rate;
292 	u16 vlan;
293 	__be16 vlan_proto;
294 	u16 qos;
295 	u8 vf_mac[ETH_ALEN];
296 	bool spoofchk_enabled;
297 	bool trusted;
298 	bool rss_query_enabled;
299 };
300 
301 struct nsim_dev {
302 	struct nsim_bus_dev *nsim_bus_dev;
303 	struct nsim_fib_data *fib_data;
304 	struct nsim_trap_data *trap_data;
305 	struct dentry *ddir;
306 	struct dentry *ports_ddir;
307 	struct dentry *take_snapshot;
308 	struct dentry *nodes_ddir;
309 
310 	struct nsim_vf_config *vfconfigs;
311 
312 	struct bpf_offload_dev *bpf_dev;
313 	bool bpf_bind_accept;
314 	bool bpf_bind_verifier_accept;
315 	u32 bpf_bind_verifier_delay;
316 	struct dentry *ddir_bpf_bound_progs;
317 	u32 prog_id_gen;
318 	struct list_head bpf_bound_progs;
319 	struct list_head bpf_bound_maps;
320 	struct netdev_phys_item_id switch_id;
321 	struct list_head port_list;
322 	bool fw_update_status;
323 	u32 fw_update_overwrite_mask;
324 	u32 max_macs;
325 	bool test1;
326 	bool dont_allow_reload;
327 	bool fail_reload;
328 	struct devlink_region *dummy_region;
329 	struct nsim_dev_health health;
330 	struct nsim_dev_hwstats hwstats;
331 	struct flow_action_cookie *fa_cookie;
332 	spinlock_t fa_cookie_lock; /* protects fa_cookie */
333 	bool fail_trap_group_set;
334 	bool fail_trap_policer_set;
335 	bool fail_trap_policer_counter_get;
336 	bool fail_trap_drop_counter_get;
337 	struct {
338 		struct udp_tunnel_nic_shared utn_shared;
339 		u32 __ports[2][NSIM_UDP_TUNNEL_N_PORTS];
340 		bool sync_all;
341 		bool open_only;
342 		bool ipv4_only;
343 		bool shared;
344 		bool static_iana_vxlan;
345 		u32 sleep;
346 	} udp_ports;
347 	struct nsim_dev_psample *psample;
348 	u16 esw_mode;
349 };
350 
nsim_esw_mode_is_legacy(struct nsim_dev * nsim_dev)351 static inline bool nsim_esw_mode_is_legacy(struct nsim_dev *nsim_dev)
352 {
353 	return nsim_dev->esw_mode == DEVLINK_ESWITCH_MODE_LEGACY;
354 }
355 
nsim_esw_mode_is_switchdev(struct nsim_dev * nsim_dev)356 static inline bool nsim_esw_mode_is_switchdev(struct nsim_dev *nsim_dev)
357 {
358 	return nsim_dev->esw_mode == DEVLINK_ESWITCH_MODE_SWITCHDEV;
359 }
360 
nsim_dev_net(struct nsim_dev * nsim_dev)361 static inline struct net *nsim_dev_net(struct nsim_dev *nsim_dev)
362 {
363 	return devlink_net(priv_to_devlink(nsim_dev));
364 }
365 
366 int nsim_dev_init(void);
367 void nsim_dev_exit(void);
368 int nsim_drv_probe(struct nsim_bus_dev *nsim_bus_dev);
369 void nsim_drv_remove(struct nsim_bus_dev *nsim_bus_dev);
370 int nsim_drv_port_add(struct nsim_bus_dev *nsim_bus_dev,
371 		      enum nsim_dev_port_type type,
372 		      unsigned int port_index);
373 int nsim_drv_port_del(struct nsim_bus_dev *nsim_bus_dev,
374 		      enum nsim_dev_port_type type,
375 		      unsigned int port_index);
376 int nsim_drv_configure_vfs(struct nsim_bus_dev *nsim_bus_dev,
377 			   unsigned int num_vfs);
378 
379 unsigned int nsim_dev_get_vfs(struct nsim_dev *nsim_dev);
380 
381 struct nsim_fib_data *nsim_fib_create(struct devlink *devlink,
382 				      struct netlink_ext_ack *extack);
383 void nsim_fib_destroy(struct devlink *devlink, struct nsim_fib_data *fib_data);
384 u64 nsim_fib_get_val(struct nsim_fib_data *fib_data,
385 		     enum nsim_resource_id res_id, bool max);
386 
nsim_dev_port_is_pf(struct nsim_dev_port * nsim_dev_port)387 static inline bool nsim_dev_port_is_pf(struct nsim_dev_port *nsim_dev_port)
388 {
389 	return nsim_dev_port->port_type == NSIM_DEV_PORT_TYPE_PF;
390 }
391 
nsim_dev_port_is_vf(struct nsim_dev_port * nsim_dev_port)392 static inline bool nsim_dev_port_is_vf(struct nsim_dev_port *nsim_dev_port)
393 {
394 	return nsim_dev_port->port_type == NSIM_DEV_PORT_TYPE_VF;
395 }
396 #if IS_ENABLED(CONFIG_XFRM_OFFLOAD)
397 void nsim_ipsec_init(struct netdevsim *ns);
398 void nsim_ipsec_teardown(struct netdevsim *ns);
399 bool nsim_ipsec_tx(struct netdevsim *ns, struct sk_buff *skb);
400 #else
nsim_ipsec_init(struct netdevsim * ns)401 static inline void nsim_ipsec_init(struct netdevsim *ns)
402 {
403 }
404 
nsim_ipsec_teardown(struct netdevsim * ns)405 static inline void nsim_ipsec_teardown(struct netdevsim *ns)
406 {
407 }
408 
nsim_ipsec_tx(struct netdevsim * ns,struct sk_buff * skb)409 static inline bool nsim_ipsec_tx(struct netdevsim *ns, struct sk_buff *skb)
410 {
411 	return true;
412 }
413 #endif
414 
415 #if IS_ENABLED(CONFIG_MACSEC)
416 void nsim_macsec_init(struct netdevsim *ns);
417 void nsim_macsec_teardown(struct netdevsim *ns);
418 #else
nsim_macsec_init(struct netdevsim * ns)419 static inline void nsim_macsec_init(struct netdevsim *ns)
420 {
421 }
422 
nsim_macsec_teardown(struct netdevsim * ns)423 static inline void nsim_macsec_teardown(struct netdevsim *ns)
424 {
425 }
426 #endif
427 
428 struct nsim_bus_dev {
429 	struct device dev;
430 	struct list_head list;
431 	unsigned int port_count;
432 	unsigned int num_queues; /* Number of queues for each port on this bus */
433 	struct net *initial_net; /* Purpose of this is to carry net pointer
434 				  * during the probe time only.
435 				  */
436 	unsigned int max_vfs;
437 	unsigned int num_vfs;
438 	bool init;
439 };
440 
441 int nsim_bus_init(void);
442 void nsim_bus_exit(void);
443