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