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