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