WIP FPC-III support
[linux/fpc-iii.git] / drivers / net / net_failover.c
blob2a4892402ed8c46ba0b12c56a086c44c0a56052c
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2018, Intel Corporation. */
4 /* This provides a net_failover interface for paravirtual drivers to
5 * provide an alternate datapath by exporting APIs to create and
6 * destroy a upper 'net_failover' netdev. The upper dev manages the
7 * original paravirtual interface as a 'standby' netdev and uses the
8 * generic failover infrastructure to register and manage a direct
9 * attached VF as a 'primary' netdev. This enables live migration of
10 * a VM with direct attached VF by failing over to the paravirtual
11 * datapath when the VF is unplugged.
13 * Some of the netdev management routines are based on bond/team driver as
14 * this driver provides active-backup functionality similar to those drivers.
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/ethtool.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/netpoll.h>
23 #include <linux/rtnetlink.h>
24 #include <linux/if_vlan.h>
25 #include <linux/pci.h>
26 #include <net/sch_generic.h>
27 #include <uapi/linux/if_arp.h>
28 #include <net/net_failover.h>
30 static bool net_failover_xmit_ready(struct net_device *dev)
32 return netif_running(dev) && netif_carrier_ok(dev);
35 static int net_failover_open(struct net_device *dev)
37 struct net_failover_info *nfo_info = netdev_priv(dev);
38 struct net_device *primary_dev, *standby_dev;
39 int err;
41 primary_dev = rtnl_dereference(nfo_info->primary_dev);
42 if (primary_dev) {
43 err = dev_open(primary_dev, NULL);
44 if (err)
45 goto err_primary_open;
48 standby_dev = rtnl_dereference(nfo_info->standby_dev);
49 if (standby_dev) {
50 err = dev_open(standby_dev, NULL);
51 if (err)
52 goto err_standby_open;
55 if ((primary_dev && net_failover_xmit_ready(primary_dev)) ||
56 (standby_dev && net_failover_xmit_ready(standby_dev))) {
57 netif_carrier_on(dev);
58 netif_tx_wake_all_queues(dev);
61 return 0;
63 err_standby_open:
64 if (primary_dev)
65 dev_close(primary_dev);
66 err_primary_open:
67 netif_tx_disable(dev);
68 return err;
71 static int net_failover_close(struct net_device *dev)
73 struct net_failover_info *nfo_info = netdev_priv(dev);
74 struct net_device *slave_dev;
76 netif_tx_disable(dev);
78 slave_dev = rtnl_dereference(nfo_info->primary_dev);
79 if (slave_dev)
80 dev_close(slave_dev);
82 slave_dev = rtnl_dereference(nfo_info->standby_dev);
83 if (slave_dev)
84 dev_close(slave_dev);
86 return 0;
89 static netdev_tx_t net_failover_drop_xmit(struct sk_buff *skb,
90 struct net_device *dev)
92 atomic_long_inc(&dev->tx_dropped);
93 dev_kfree_skb_any(skb);
94 return NETDEV_TX_OK;
97 static netdev_tx_t net_failover_start_xmit(struct sk_buff *skb,
98 struct net_device *dev)
100 struct net_failover_info *nfo_info = netdev_priv(dev);
101 struct net_device *xmit_dev;
103 /* Try xmit via primary netdev followed by standby netdev */
104 xmit_dev = rcu_dereference_bh(nfo_info->primary_dev);
105 if (!xmit_dev || !net_failover_xmit_ready(xmit_dev)) {
106 xmit_dev = rcu_dereference_bh(nfo_info->standby_dev);
107 if (!xmit_dev || !net_failover_xmit_ready(xmit_dev))
108 return net_failover_drop_xmit(skb, dev);
111 skb->dev = xmit_dev;
112 skb->queue_mapping = qdisc_skb_cb(skb)->slave_dev_queue_mapping;
114 return dev_queue_xmit(skb);
117 static u16 net_failover_select_queue(struct net_device *dev,
118 struct sk_buff *skb,
119 struct net_device *sb_dev)
121 struct net_failover_info *nfo_info = netdev_priv(dev);
122 struct net_device *primary_dev;
123 u16 txq;
125 primary_dev = rcu_dereference(nfo_info->primary_dev);
126 if (primary_dev) {
127 const struct net_device_ops *ops = primary_dev->netdev_ops;
129 if (ops->ndo_select_queue)
130 txq = ops->ndo_select_queue(primary_dev, skb, sb_dev);
131 else
132 txq = netdev_pick_tx(primary_dev, skb, NULL);
134 qdisc_skb_cb(skb)->slave_dev_queue_mapping = skb->queue_mapping;
136 return txq;
139 txq = skb_rx_queue_recorded(skb) ? skb_get_rx_queue(skb) : 0;
141 /* Save the original txq to restore before passing to the driver */
142 qdisc_skb_cb(skb)->slave_dev_queue_mapping = skb->queue_mapping;
144 if (unlikely(txq >= dev->real_num_tx_queues)) {
145 do {
146 txq -= dev->real_num_tx_queues;
147 } while (txq >= dev->real_num_tx_queues);
150 return txq;
153 /* fold stats, assuming all rtnl_link_stats64 fields are u64, but
154 * that some drivers can provide 32bit values only.
156 static void net_failover_fold_stats(struct rtnl_link_stats64 *_res,
157 const struct rtnl_link_stats64 *_new,
158 const struct rtnl_link_stats64 *_old)
160 const u64 *new = (const u64 *)_new;
161 const u64 *old = (const u64 *)_old;
162 u64 *res = (u64 *)_res;
163 int i;
165 for (i = 0; i < sizeof(*_res) / sizeof(u64); i++) {
166 u64 nv = new[i];
167 u64 ov = old[i];
168 s64 delta = nv - ov;
170 /* detects if this particular field is 32bit only */
171 if (((nv | ov) >> 32) == 0)
172 delta = (s64)(s32)((u32)nv - (u32)ov);
174 /* filter anomalies, some drivers reset their stats
175 * at down/up events.
177 if (delta > 0)
178 res[i] += delta;
182 static void net_failover_get_stats(struct net_device *dev,
183 struct rtnl_link_stats64 *stats)
185 struct net_failover_info *nfo_info = netdev_priv(dev);
186 const struct rtnl_link_stats64 *new;
187 struct rtnl_link_stats64 temp;
188 struct net_device *slave_dev;
190 spin_lock(&nfo_info->stats_lock);
191 memcpy(stats, &nfo_info->failover_stats, sizeof(*stats));
193 rcu_read_lock();
195 slave_dev = rcu_dereference(nfo_info->primary_dev);
196 if (slave_dev) {
197 new = dev_get_stats(slave_dev, &temp);
198 net_failover_fold_stats(stats, new, &nfo_info->primary_stats);
199 memcpy(&nfo_info->primary_stats, new, sizeof(*new));
202 slave_dev = rcu_dereference(nfo_info->standby_dev);
203 if (slave_dev) {
204 new = dev_get_stats(slave_dev, &temp);
205 net_failover_fold_stats(stats, new, &nfo_info->standby_stats);
206 memcpy(&nfo_info->standby_stats, new, sizeof(*new));
209 rcu_read_unlock();
211 memcpy(&nfo_info->failover_stats, stats, sizeof(*stats));
212 spin_unlock(&nfo_info->stats_lock);
215 static int net_failover_change_mtu(struct net_device *dev, int new_mtu)
217 struct net_failover_info *nfo_info = netdev_priv(dev);
218 struct net_device *primary_dev, *standby_dev;
219 int ret = 0;
221 primary_dev = rtnl_dereference(nfo_info->primary_dev);
222 if (primary_dev) {
223 ret = dev_set_mtu(primary_dev, new_mtu);
224 if (ret)
225 return ret;
228 standby_dev = rtnl_dereference(nfo_info->standby_dev);
229 if (standby_dev) {
230 ret = dev_set_mtu(standby_dev, new_mtu);
231 if (ret) {
232 if (primary_dev)
233 dev_set_mtu(primary_dev, dev->mtu);
234 return ret;
238 dev->mtu = new_mtu;
240 return 0;
243 static void net_failover_set_rx_mode(struct net_device *dev)
245 struct net_failover_info *nfo_info = netdev_priv(dev);
246 struct net_device *slave_dev;
248 rcu_read_lock();
250 slave_dev = rcu_dereference(nfo_info->primary_dev);
251 if (slave_dev) {
252 dev_uc_sync_multiple(slave_dev, dev);
253 dev_mc_sync_multiple(slave_dev, dev);
256 slave_dev = rcu_dereference(nfo_info->standby_dev);
257 if (slave_dev) {
258 dev_uc_sync_multiple(slave_dev, dev);
259 dev_mc_sync_multiple(slave_dev, dev);
262 rcu_read_unlock();
265 static int net_failover_vlan_rx_add_vid(struct net_device *dev, __be16 proto,
266 u16 vid)
268 struct net_failover_info *nfo_info = netdev_priv(dev);
269 struct net_device *primary_dev, *standby_dev;
270 int ret = 0;
272 primary_dev = rcu_dereference(nfo_info->primary_dev);
273 if (primary_dev) {
274 ret = vlan_vid_add(primary_dev, proto, vid);
275 if (ret)
276 return ret;
279 standby_dev = rcu_dereference(nfo_info->standby_dev);
280 if (standby_dev) {
281 ret = vlan_vid_add(standby_dev, proto, vid);
282 if (ret)
283 if (primary_dev)
284 vlan_vid_del(primary_dev, proto, vid);
287 return ret;
290 static int net_failover_vlan_rx_kill_vid(struct net_device *dev, __be16 proto,
291 u16 vid)
293 struct net_failover_info *nfo_info = netdev_priv(dev);
294 struct net_device *slave_dev;
296 slave_dev = rcu_dereference(nfo_info->primary_dev);
297 if (slave_dev)
298 vlan_vid_del(slave_dev, proto, vid);
300 slave_dev = rcu_dereference(nfo_info->standby_dev);
301 if (slave_dev)
302 vlan_vid_del(slave_dev, proto, vid);
304 return 0;
307 static const struct net_device_ops failover_dev_ops = {
308 .ndo_open = net_failover_open,
309 .ndo_stop = net_failover_close,
310 .ndo_start_xmit = net_failover_start_xmit,
311 .ndo_select_queue = net_failover_select_queue,
312 .ndo_get_stats64 = net_failover_get_stats,
313 .ndo_change_mtu = net_failover_change_mtu,
314 .ndo_set_rx_mode = net_failover_set_rx_mode,
315 .ndo_vlan_rx_add_vid = net_failover_vlan_rx_add_vid,
316 .ndo_vlan_rx_kill_vid = net_failover_vlan_rx_kill_vid,
317 .ndo_validate_addr = eth_validate_addr,
318 .ndo_features_check = passthru_features_check,
321 #define FAILOVER_NAME "net_failover"
322 #define FAILOVER_VERSION "0.1"
324 static void nfo_ethtool_get_drvinfo(struct net_device *dev,
325 struct ethtool_drvinfo *drvinfo)
327 strlcpy(drvinfo->driver, FAILOVER_NAME, sizeof(drvinfo->driver));
328 strlcpy(drvinfo->version, FAILOVER_VERSION, sizeof(drvinfo->version));
331 static int nfo_ethtool_get_link_ksettings(struct net_device *dev,
332 struct ethtool_link_ksettings *cmd)
334 struct net_failover_info *nfo_info = netdev_priv(dev);
335 struct net_device *slave_dev;
337 slave_dev = rtnl_dereference(nfo_info->primary_dev);
338 if (!slave_dev || !net_failover_xmit_ready(slave_dev)) {
339 slave_dev = rtnl_dereference(nfo_info->standby_dev);
340 if (!slave_dev || !net_failover_xmit_ready(slave_dev)) {
341 cmd->base.duplex = DUPLEX_UNKNOWN;
342 cmd->base.port = PORT_OTHER;
343 cmd->base.speed = SPEED_UNKNOWN;
345 return 0;
349 return __ethtool_get_link_ksettings(slave_dev, cmd);
352 static const struct ethtool_ops failover_ethtool_ops = {
353 .get_drvinfo = nfo_ethtool_get_drvinfo,
354 .get_link = ethtool_op_get_link,
355 .get_link_ksettings = nfo_ethtool_get_link_ksettings,
358 /* Called when slave dev is injecting data into network stack.
359 * Change the associated network device from lower dev to failover dev.
360 * note: already called with rcu_read_lock
362 static rx_handler_result_t net_failover_handle_frame(struct sk_buff **pskb)
364 struct sk_buff *skb = *pskb;
365 struct net_device *dev = rcu_dereference(skb->dev->rx_handler_data);
366 struct net_failover_info *nfo_info = netdev_priv(dev);
367 struct net_device *primary_dev, *standby_dev;
369 primary_dev = rcu_dereference(nfo_info->primary_dev);
370 standby_dev = rcu_dereference(nfo_info->standby_dev);
372 if (primary_dev && skb->dev == standby_dev)
373 return RX_HANDLER_EXACT;
375 skb->dev = dev;
377 return RX_HANDLER_ANOTHER;
380 static void net_failover_compute_features(struct net_device *dev)
382 netdev_features_t vlan_features = FAILOVER_VLAN_FEATURES &
383 NETIF_F_ALL_FOR_ALL;
384 netdev_features_t enc_features = FAILOVER_ENC_FEATURES;
385 unsigned short max_hard_header_len = ETH_HLEN;
386 unsigned int dst_release_flag = IFF_XMIT_DST_RELEASE |
387 IFF_XMIT_DST_RELEASE_PERM;
388 struct net_failover_info *nfo_info = netdev_priv(dev);
389 struct net_device *primary_dev, *standby_dev;
391 primary_dev = rcu_dereference(nfo_info->primary_dev);
392 if (primary_dev) {
393 vlan_features =
394 netdev_increment_features(vlan_features,
395 primary_dev->vlan_features,
396 FAILOVER_VLAN_FEATURES);
397 enc_features =
398 netdev_increment_features(enc_features,
399 primary_dev->hw_enc_features,
400 FAILOVER_ENC_FEATURES);
402 dst_release_flag &= primary_dev->priv_flags;
403 if (primary_dev->hard_header_len > max_hard_header_len)
404 max_hard_header_len = primary_dev->hard_header_len;
407 standby_dev = rcu_dereference(nfo_info->standby_dev);
408 if (standby_dev) {
409 vlan_features =
410 netdev_increment_features(vlan_features,
411 standby_dev->vlan_features,
412 FAILOVER_VLAN_FEATURES);
413 enc_features =
414 netdev_increment_features(enc_features,
415 standby_dev->hw_enc_features,
416 FAILOVER_ENC_FEATURES);
418 dst_release_flag &= standby_dev->priv_flags;
419 if (standby_dev->hard_header_len > max_hard_header_len)
420 max_hard_header_len = standby_dev->hard_header_len;
423 dev->vlan_features = vlan_features;
424 dev->hw_enc_features = enc_features | NETIF_F_GSO_ENCAP_ALL;
425 dev->hard_header_len = max_hard_header_len;
427 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
428 if (dst_release_flag == (IFF_XMIT_DST_RELEASE |
429 IFF_XMIT_DST_RELEASE_PERM))
430 dev->priv_flags |= IFF_XMIT_DST_RELEASE;
432 netdev_change_features(dev);
435 static void net_failover_lower_state_changed(struct net_device *slave_dev,
436 struct net_device *primary_dev,
437 struct net_device *standby_dev)
439 struct netdev_lag_lower_state_info info;
441 if (netif_carrier_ok(slave_dev))
442 info.link_up = true;
443 else
444 info.link_up = false;
446 if (slave_dev == primary_dev) {
447 if (netif_running(primary_dev))
448 info.tx_enabled = true;
449 else
450 info.tx_enabled = false;
451 } else {
452 if ((primary_dev && netif_running(primary_dev)) ||
453 (!netif_running(standby_dev)))
454 info.tx_enabled = false;
455 else
456 info.tx_enabled = true;
459 netdev_lower_state_changed(slave_dev, &info);
462 static int net_failover_slave_pre_register(struct net_device *slave_dev,
463 struct net_device *failover_dev)
465 struct net_device *standby_dev, *primary_dev;
466 struct net_failover_info *nfo_info;
467 bool slave_is_standby;
469 nfo_info = netdev_priv(failover_dev);
470 standby_dev = rtnl_dereference(nfo_info->standby_dev);
471 primary_dev = rtnl_dereference(nfo_info->primary_dev);
472 slave_is_standby = slave_dev->dev.parent == failover_dev->dev.parent;
473 if (slave_is_standby ? standby_dev : primary_dev) {
474 netdev_err(failover_dev, "%s attempting to register as slave dev when %s already present\n",
475 slave_dev->name,
476 slave_is_standby ? "standby" : "primary");
477 return -EINVAL;
480 /* We want to allow only a direct attached VF device as a primary
481 * netdev. As there is no easy way to check for a VF device, restrict
482 * this to a pci device.
484 if (!slave_is_standby && (!slave_dev->dev.parent ||
485 !dev_is_pci(slave_dev->dev.parent)))
486 return -EINVAL;
488 if (failover_dev->features & NETIF_F_VLAN_CHALLENGED &&
489 vlan_uses_dev(failover_dev)) {
490 netdev_err(failover_dev, "Device %s is VLAN challenged and failover device has VLAN set up\n",
491 failover_dev->name);
492 return -EINVAL;
495 return 0;
498 static int net_failover_slave_register(struct net_device *slave_dev,
499 struct net_device *failover_dev)
501 struct net_device *standby_dev, *primary_dev;
502 struct net_failover_info *nfo_info;
503 bool slave_is_standby;
504 u32 orig_mtu;
505 int err;
507 /* Align MTU of slave with failover dev */
508 orig_mtu = slave_dev->mtu;
509 err = dev_set_mtu(slave_dev, failover_dev->mtu);
510 if (err) {
511 netdev_err(failover_dev, "unable to change mtu of %s to %u register failed\n",
512 slave_dev->name, failover_dev->mtu);
513 goto done;
516 dev_hold(slave_dev);
518 if (netif_running(failover_dev)) {
519 err = dev_open(slave_dev, NULL);
520 if (err && (err != -EBUSY)) {
521 netdev_err(failover_dev, "Opening slave %s failed err:%d\n",
522 slave_dev->name, err);
523 goto err_dev_open;
527 netif_addr_lock_bh(failover_dev);
528 dev_uc_sync_multiple(slave_dev, failover_dev);
529 dev_mc_sync_multiple(slave_dev, failover_dev);
530 netif_addr_unlock_bh(failover_dev);
532 err = vlan_vids_add_by_dev(slave_dev, failover_dev);
533 if (err) {
534 netdev_err(failover_dev, "Failed to add vlan ids to device %s err:%d\n",
535 slave_dev->name, err);
536 goto err_vlan_add;
539 nfo_info = netdev_priv(failover_dev);
540 standby_dev = rtnl_dereference(nfo_info->standby_dev);
541 primary_dev = rtnl_dereference(nfo_info->primary_dev);
542 slave_is_standby = slave_dev->dev.parent == failover_dev->dev.parent;
544 if (slave_is_standby) {
545 rcu_assign_pointer(nfo_info->standby_dev, slave_dev);
546 standby_dev = slave_dev;
547 dev_get_stats(standby_dev, &nfo_info->standby_stats);
548 } else {
549 rcu_assign_pointer(nfo_info->primary_dev, slave_dev);
550 primary_dev = slave_dev;
551 dev_get_stats(primary_dev, &nfo_info->primary_stats);
552 failover_dev->min_mtu = slave_dev->min_mtu;
553 failover_dev->max_mtu = slave_dev->max_mtu;
556 net_failover_lower_state_changed(slave_dev, primary_dev, standby_dev);
557 net_failover_compute_features(failover_dev);
559 call_netdevice_notifiers(NETDEV_JOIN, slave_dev);
561 netdev_info(failover_dev, "failover %s slave:%s registered\n",
562 slave_is_standby ? "standby" : "primary", slave_dev->name);
564 return 0;
566 err_vlan_add:
567 dev_uc_unsync(slave_dev, failover_dev);
568 dev_mc_unsync(slave_dev, failover_dev);
569 dev_close(slave_dev);
570 err_dev_open:
571 dev_put(slave_dev);
572 dev_set_mtu(slave_dev, orig_mtu);
573 done:
574 return err;
577 static int net_failover_slave_pre_unregister(struct net_device *slave_dev,
578 struct net_device *failover_dev)
580 struct net_device *standby_dev, *primary_dev;
581 struct net_failover_info *nfo_info;
583 nfo_info = netdev_priv(failover_dev);
584 primary_dev = rtnl_dereference(nfo_info->primary_dev);
585 standby_dev = rtnl_dereference(nfo_info->standby_dev);
587 if (slave_dev != primary_dev && slave_dev != standby_dev)
588 return -ENODEV;
590 return 0;
593 static int net_failover_slave_unregister(struct net_device *slave_dev,
594 struct net_device *failover_dev)
596 struct net_device *standby_dev, *primary_dev;
597 struct net_failover_info *nfo_info;
598 bool slave_is_standby;
600 nfo_info = netdev_priv(failover_dev);
601 primary_dev = rtnl_dereference(nfo_info->primary_dev);
602 standby_dev = rtnl_dereference(nfo_info->standby_dev);
604 if (WARN_ON_ONCE(slave_dev != primary_dev && slave_dev != standby_dev))
605 return -ENODEV;
607 vlan_vids_del_by_dev(slave_dev, failover_dev);
608 dev_uc_unsync(slave_dev, failover_dev);
609 dev_mc_unsync(slave_dev, failover_dev);
610 dev_close(slave_dev);
612 nfo_info = netdev_priv(failover_dev);
613 dev_get_stats(failover_dev, &nfo_info->failover_stats);
615 slave_is_standby = slave_dev->dev.parent == failover_dev->dev.parent;
616 if (slave_is_standby) {
617 RCU_INIT_POINTER(nfo_info->standby_dev, NULL);
618 } else {
619 RCU_INIT_POINTER(nfo_info->primary_dev, NULL);
620 if (standby_dev) {
621 failover_dev->min_mtu = standby_dev->min_mtu;
622 failover_dev->max_mtu = standby_dev->max_mtu;
626 dev_put(slave_dev);
628 net_failover_compute_features(failover_dev);
630 netdev_info(failover_dev, "failover %s slave:%s unregistered\n",
631 slave_is_standby ? "standby" : "primary", slave_dev->name);
633 return 0;
636 static int net_failover_slave_link_change(struct net_device *slave_dev,
637 struct net_device *failover_dev)
639 struct net_device *primary_dev, *standby_dev;
640 struct net_failover_info *nfo_info;
642 nfo_info = netdev_priv(failover_dev);
644 primary_dev = rtnl_dereference(nfo_info->primary_dev);
645 standby_dev = rtnl_dereference(nfo_info->standby_dev);
647 if (slave_dev != primary_dev && slave_dev != standby_dev)
648 return -ENODEV;
650 if ((primary_dev && net_failover_xmit_ready(primary_dev)) ||
651 (standby_dev && net_failover_xmit_ready(standby_dev))) {
652 netif_carrier_on(failover_dev);
653 netif_tx_wake_all_queues(failover_dev);
654 } else {
655 dev_get_stats(failover_dev, &nfo_info->failover_stats);
656 netif_carrier_off(failover_dev);
657 netif_tx_stop_all_queues(failover_dev);
660 net_failover_lower_state_changed(slave_dev, primary_dev, standby_dev);
662 return 0;
665 static int net_failover_slave_name_change(struct net_device *slave_dev,
666 struct net_device *failover_dev)
668 struct net_device *primary_dev, *standby_dev;
669 struct net_failover_info *nfo_info;
671 nfo_info = netdev_priv(failover_dev);
673 primary_dev = rtnl_dereference(nfo_info->primary_dev);
674 standby_dev = rtnl_dereference(nfo_info->standby_dev);
676 if (slave_dev != primary_dev && slave_dev != standby_dev)
677 return -ENODEV;
679 /* We need to bring up the slave after the rename by udev in case
680 * open failed with EBUSY when it was registered.
682 dev_open(slave_dev, NULL);
684 return 0;
687 static struct failover_ops net_failover_ops = {
688 .slave_pre_register = net_failover_slave_pre_register,
689 .slave_register = net_failover_slave_register,
690 .slave_pre_unregister = net_failover_slave_pre_unregister,
691 .slave_unregister = net_failover_slave_unregister,
692 .slave_link_change = net_failover_slave_link_change,
693 .slave_name_change = net_failover_slave_name_change,
694 .slave_handle_frame = net_failover_handle_frame,
698 * net_failover_create - Create and register a failover instance
700 * @standby_dev: standby netdev
702 * Creates a failover netdev and registers a failover instance for a standby
703 * netdev. Used by paravirtual drivers that use 3-netdev model.
704 * The failover netdev acts as a master device and controls 2 slave devices -
705 * the original standby netdev and a VF netdev with the same MAC gets
706 * registered as primary netdev.
708 * Return: pointer to failover instance
710 struct failover *net_failover_create(struct net_device *standby_dev)
712 struct device *dev = standby_dev->dev.parent;
713 struct net_device *failover_dev;
714 struct failover *failover;
715 int err;
717 /* Alloc at least 2 queues, for now we are going with 16 assuming
718 * that VF devices being enslaved won't have too many queues.
720 failover_dev = alloc_etherdev_mq(sizeof(struct net_failover_info), 16);
721 if (!failover_dev) {
722 dev_err(dev, "Unable to allocate failover_netdev!\n");
723 return ERR_PTR(-ENOMEM);
726 dev_net_set(failover_dev, dev_net(standby_dev));
727 SET_NETDEV_DEV(failover_dev, dev);
729 failover_dev->netdev_ops = &failover_dev_ops;
730 failover_dev->ethtool_ops = &failover_ethtool_ops;
732 /* Initialize the device options */
733 failover_dev->priv_flags |= IFF_UNICAST_FLT | IFF_NO_QUEUE;
734 failover_dev->priv_flags &= ~(IFF_XMIT_DST_RELEASE |
735 IFF_TX_SKB_SHARING);
737 /* don't acquire failover netdev's netif_tx_lock when transmitting */
738 failover_dev->features |= NETIF_F_LLTX;
740 /* Don't allow failover devices to change network namespaces. */
741 failover_dev->features |= NETIF_F_NETNS_LOCAL;
743 failover_dev->hw_features = FAILOVER_VLAN_FEATURES |
744 NETIF_F_HW_VLAN_CTAG_TX |
745 NETIF_F_HW_VLAN_CTAG_RX |
746 NETIF_F_HW_VLAN_CTAG_FILTER;
748 failover_dev->hw_features |= NETIF_F_GSO_ENCAP_ALL;
749 failover_dev->features |= failover_dev->hw_features;
751 memcpy(failover_dev->dev_addr, standby_dev->dev_addr,
752 failover_dev->addr_len);
754 failover_dev->min_mtu = standby_dev->min_mtu;
755 failover_dev->max_mtu = standby_dev->max_mtu;
757 err = register_netdev(failover_dev);
758 if (err) {
759 dev_err(dev, "Unable to register failover_dev!\n");
760 goto err_register_netdev;
763 netif_carrier_off(failover_dev);
765 failover = failover_register(failover_dev, &net_failover_ops);
766 if (IS_ERR(failover)) {
767 err = PTR_ERR(failover);
768 goto err_failover_register;
771 return failover;
773 err_failover_register:
774 unregister_netdev(failover_dev);
775 err_register_netdev:
776 free_netdev(failover_dev);
778 return ERR_PTR(err);
780 EXPORT_SYMBOL_GPL(net_failover_create);
783 * net_failover_destroy - Destroy a failover instance
785 * @failover: pointer to failover instance
787 * Unregisters any slave netdevs associated with the failover instance by
788 * calling failover_slave_unregister().
789 * unregisters the failover instance itself and finally frees the failover
790 * netdev. Used by paravirtual drivers that use 3-netdev model.
793 void net_failover_destroy(struct failover *failover)
795 struct net_failover_info *nfo_info;
796 struct net_device *failover_dev;
797 struct net_device *slave_dev;
799 if (!failover)
800 return;
802 failover_dev = rcu_dereference(failover->failover_dev);
803 nfo_info = netdev_priv(failover_dev);
805 netif_device_detach(failover_dev);
807 rtnl_lock();
809 slave_dev = rtnl_dereference(nfo_info->primary_dev);
810 if (slave_dev)
811 failover_slave_unregister(slave_dev);
813 slave_dev = rtnl_dereference(nfo_info->standby_dev);
814 if (slave_dev)
815 failover_slave_unregister(slave_dev);
817 failover_unregister(failover);
819 unregister_netdevice(failover_dev);
821 rtnl_unlock();
823 free_netdev(failover_dev);
825 EXPORT_SYMBOL_GPL(net_failover_destroy);
827 static __init int
828 net_failover_init(void)
830 return 0;
832 module_init(net_failover_init);
834 static __exit
835 void net_failover_exit(void)
838 module_exit(net_failover_exit);
840 MODULE_DESCRIPTION("Failover driver for Paravirtual drivers");
841 MODULE_LICENSE("GPL v2");