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