ethernet/sun/sunvnet.c

0001 // SPDX-License-Identifier: GPL-2.0
0002 /* sunvnet.c: Sun LDOM Virtual Network Driver.
0003  *
0004  * Copyright (C) 2007, 2008 David S. Miller <davem@davemloft.net>
0005  * Copyright (C) 2016-2017 Oracle. All rights reserved.
0006  */
0007
0008 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
0009
0010 #include <linux/module.h>
0011 #include <linux/kernel.h>
0012 #include <linux/types.h>
0013 #include <linux/slab.h>
0014 #include <linux/delay.h>
0015 #include <linux/init.h>
0016 #include <linux/netdevice.h>
0017 #include <linux/ethtool.h>
0018 #include <linux/etherdevice.h>
0019 #include <linux/mutex.h>
0020 #include <linux/highmem.h>
0021 #include <linux/if_vlan.h>
0022
0023 #if IS_ENABLED(CONFIG_IPV6)
0024 #include <linux/icmpv6.h>
0025 #endif
0026
0027 #include <net/ip.h>
0028 #include <net/icmp.h>
0029 #include <net/route.h>
0030
0031 #include <asm/vio.h>
0032 #include <asm/ldc.h>
0033
0034 #include "sunvnet_common.h"
0035
0036 /* length of time before we decide the hardware is borked,
0037  * and dev->tx_timeout() should be called to fix the problem
0038  */
0039 #define VNET_TX_TIMEOUT         (5 * HZ)
0040
0041 #define DRV_MODULE_NAME     "sunvnet"
0042 #define DRV_MODULE_VERSION  "2.0"
0043 #define DRV_MODULE_RELDATE  "February 3, 2017"
0044
0045 static char version[] =
0046     DRV_MODULE_NAME " " DRV_MODULE_VERSION " (" DRV_MODULE_RELDATE ")";
0047 MODULE_AUTHOR("David S. Miller (davem@davemloft.net)");
0048 MODULE_DESCRIPTION("Sun LDOM virtual network driver");
0049 MODULE_LICENSE("GPL");
0050 MODULE_VERSION(DRV_MODULE_VERSION);
0051
0052 /* Ordered from largest major to lowest */
0053 static struct vio_version vnet_versions[] = {
0054     { .major = 1, .minor = 8 },
0055     { .major = 1, .minor = 7 },
0056     { .major = 1, .minor = 6 },
0057     { .major = 1, .minor = 0 },
0058 };
0059
0060 static void vnet_get_drvinfo(struct net_device *dev,
0061                  struct ethtool_drvinfo *info)
0062 {
0063     strlcpy(info->driver, DRV_MODULE_NAME, sizeof(info->driver));
0064     strlcpy(info->version, DRV_MODULE_VERSION, sizeof(info->version));
0065 }
0066
0067 static u32 vnet_get_msglevel(struct net_device *dev)
0068 {
0069     struct vnet *vp = netdev_priv(dev);
0070
0071     return vp->msg_enable;
0072 }
0073
0074 static void vnet_set_msglevel(struct net_device *dev, u32 value)
0075 {
0076     struct vnet *vp = netdev_priv(dev);
0077
0078     vp->msg_enable = value;
0079 }
0080
0081 static const struct {
0082     const char string[ETH_GSTRING_LEN];
0083 } ethtool_stats_keys[] = {
0084     { "rx_packets" },
0085     { "tx_packets" },
0086     { "rx_bytes" },
0087     { "tx_bytes" },
0088     { "rx_errors" },
0089     { "tx_errors" },
0090     { "rx_dropped" },
0091     { "tx_dropped" },
0092     { "multicast" },
0093     { "rx_length_errors" },
0094     { "rx_frame_errors" },
0095     { "rx_missed_errors" },
0096     { "tx_carrier_errors" },
0097     { "nports" },
0098 };
0099
0100 static int vnet_get_sset_count(struct net_device *dev, int sset)
0101 {
0102     struct vnet *vp = (struct vnet *)netdev_priv(dev);
0103
0104     switch (sset) {
0105     case ETH_SS_STATS:
0106         return ARRAY_SIZE(ethtool_stats_keys)
0107             + (NUM_VNET_PORT_STATS * vp->nports);
0108     default:
0109         return -EOPNOTSUPP;
0110     }
0111 }
0112
0113 static void vnet_get_strings(struct net_device *dev, u32 stringset, u8 *buf)
0114 {
0115     struct vnet *vp = (struct vnet *)netdev_priv(dev);
0116     struct vnet_port *port;
0117     char *p = (char *)buf;
0118
0119     switch (stringset) {
0120     case ETH_SS_STATS:
0121         memcpy(buf, &ethtool_stats_keys, sizeof(ethtool_stats_keys));
0122         p += sizeof(ethtool_stats_keys);
0123
0124         rcu_read_lock();
0125         list_for_each_entry_rcu(port, &vp->port_list, list) {
0126             snprintf(p, ETH_GSTRING_LEN, "p%u.%s-%pM",
0127                  port->q_index, port->switch_port ? "s" : "q",
0128                  port->raddr);
0129             p += ETH_GSTRING_LEN;
0130             snprintf(p, ETH_GSTRING_LEN, "p%u.rx_packets",
0131                  port->q_index);
0132             p += ETH_GSTRING_LEN;
0133             snprintf(p, ETH_GSTRING_LEN, "p%u.tx_packets",
0134                  port->q_index);
0135             p += ETH_GSTRING_LEN;
0136             snprintf(p, ETH_GSTRING_LEN, "p%u.rx_bytes",
0137                  port->q_index);
0138             p += ETH_GSTRING_LEN;
0139             snprintf(p, ETH_GSTRING_LEN, "p%u.tx_bytes",
0140                  port->q_index);
0141             p += ETH_GSTRING_LEN;
0142             snprintf(p, ETH_GSTRING_LEN, "p%u.event_up",
0143                  port->q_index);
0144             p += ETH_GSTRING_LEN;
0145             snprintf(p, ETH_GSTRING_LEN, "p%u.event_reset",
0146                  port->q_index);
0147             p += ETH_GSTRING_LEN;
0148         }
0149         rcu_read_unlock();
0150         break;
0151     default:
0152         WARN_ON(1);
0153         break;
0154     }
0155 }
0156
0157 static void vnet_get_ethtool_stats(struct net_device *dev,
0158                    struct ethtool_stats *estats, u64 *data)
0159 {
0160     struct vnet *vp = (struct vnet *)netdev_priv(dev);
0161     struct vnet_port *port;
0162     int i = 0;
0163
0164     data[i++] = dev->stats.rx_packets;
0165     data[i++] = dev->stats.tx_packets;
0166     data[i++] = dev->stats.rx_bytes;
0167     data[i++] = dev->stats.tx_bytes;
0168     data[i++] = dev->stats.rx_errors;
0169     data[i++] = dev->stats.tx_errors;
0170     data[i++] = dev->stats.rx_dropped;
0171     data[i++] = dev->stats.tx_dropped;
0172     data[i++] = dev->stats.multicast;
0173     data[i++] = dev->stats.rx_length_errors;
0174     data[i++] = dev->stats.rx_frame_errors;
0175     data[i++] = dev->stats.rx_missed_errors;
0176     data[i++] = dev->stats.tx_carrier_errors;
0177     data[i++] = vp->nports;
0178
0179     rcu_read_lock();
0180     list_for_each_entry_rcu(port, &vp->port_list, list) {
0181         data[i++] = port->q_index;
0182         data[i++] = port->stats.rx_packets;
0183         data[i++] = port->stats.tx_packets;
0184         data[i++] = port->stats.rx_bytes;
0185         data[i++] = port->stats.tx_bytes;
0186         data[i++] = port->stats.event_up;
0187         data[i++] = port->stats.event_reset;
0188     }
0189     rcu_read_unlock();
0190 }
0191
0192 static const struct ethtool_ops vnet_ethtool_ops = {
0193     .get_drvinfo        = vnet_get_drvinfo,
0194     .get_msglevel       = vnet_get_msglevel,
0195     .set_msglevel       = vnet_set_msglevel,
0196     .get_link       = ethtool_op_get_link,
0197     .get_sset_count     = vnet_get_sset_count,
0198     .get_strings        = vnet_get_strings,
0199     .get_ethtool_stats  = vnet_get_ethtool_stats,
0200 };
0201
0202 static LIST_HEAD(vnet_list);
0203 static DEFINE_MUTEX(vnet_list_mutex);
0204
0205 static struct vnet_port *__tx_port_find(struct vnet *vp, struct sk_buff *skb)
0206 {
0207     unsigned int hash = vnet_hashfn(skb->data);
0208     struct hlist_head *hp = &vp->port_hash[hash];
0209     struct vnet_port *port;
0210
0211     hlist_for_each_entry_rcu(port, hp, hash) {
0212         if (!sunvnet_port_is_up_common(port))
0213             continue;
0214         if (ether_addr_equal(port->raddr, skb->data))
0215             return port;
0216     }
0217     list_for_each_entry_rcu(port, &vp->port_list, list) {
0218         if (!port->switch_port)
0219             continue;
0220         if (!sunvnet_port_is_up_common(port))
0221             continue;
0222         return port;
0223     }
0224     return NULL;
0225 }
0226
0227 /* func arg to vnet_start_xmit_common() to get the proper tx port */
0228 static struct vnet_port *vnet_tx_port_find(struct sk_buff *skb,
0229                        struct net_device *dev)
0230 {
0231     struct vnet *vp = netdev_priv(dev);
0232
0233     return __tx_port_find(vp, skb);
0234 }
0235
0236 static u16 vnet_select_queue(struct net_device *dev, struct sk_buff *skb,
0237                  struct net_device *sb_dev)
0238 {
0239     struct vnet *vp = netdev_priv(dev);
0240     struct vnet_port *port = __tx_port_find(vp, skb);
0241
0242     if (!port)
0243         return 0;
0244
0245     return port->q_index;
0246 }
0247
0248 /* Wrappers to common functions */
0249 static netdev_tx_t vnet_start_xmit(struct sk_buff *skb, struct net_device *dev)
0250 {
0251     return sunvnet_start_xmit_common(skb, dev, vnet_tx_port_find);
0252 }
0253
0254 static void vnet_set_rx_mode(struct net_device *dev)
0255 {
0256     struct vnet *vp = netdev_priv(dev);
0257
0258     return sunvnet_set_rx_mode_common(dev, vp);
0259 }
0260
0261 #ifdef CONFIG_NET_POLL_CONTROLLER
0262 static void vnet_poll_controller(struct net_device *dev)
0263 {
0264     struct vnet *vp = netdev_priv(dev);
0265
0266     return sunvnet_poll_controller_common(dev, vp);
0267 }
0268 #endif
0269
0270 static const struct net_device_ops vnet_ops = {
0271     .ndo_open       = sunvnet_open_common,
0272     .ndo_stop       = sunvnet_close_common,
0273     .ndo_set_rx_mode    = vnet_set_rx_mode,
0274     .ndo_set_mac_address    = sunvnet_set_mac_addr_common,
0275     .ndo_validate_addr  = eth_validate_addr,
0276     .ndo_tx_timeout     = sunvnet_tx_timeout_common,
0277     .ndo_start_xmit     = vnet_start_xmit,
0278     .ndo_select_queue   = vnet_select_queue,
0279 #ifdef CONFIG_NET_POLL_CONTROLLER
0280     .ndo_poll_controller    = vnet_poll_controller,
0281 #endif
0282 };
0283
0284 static struct vnet *vnet_new(const u64 *local_mac,
0285                  struct vio_dev *vdev)
0286 {
0287     struct net_device *dev;
0288     u8 addr[ETH_ALEN];
0289     struct vnet *vp;
0290     int err, i;
0291
0292     dev = alloc_etherdev_mqs(sizeof(*vp), VNET_MAX_TXQS, 1);
0293     if (!dev)
0294         return ERR_PTR(-ENOMEM);
0295     dev->needed_headroom = VNET_PACKET_SKIP + 8;
0296     dev->needed_tailroom = 8;
0297
0298     for (i = 0; i < ETH_ALEN; i++)
0299         addr[i] = (*local_mac >> (5 - i) * 8) & 0xff;
0300     eth_hw_addr_set(dev, addr);
0301
0302     vp = netdev_priv(dev);
0303
0304     spin_lock_init(&vp->lock);
0305     vp->dev = dev;
0306
0307     INIT_LIST_HEAD(&vp->port_list);
0308     for (i = 0; i < VNET_PORT_HASH_SIZE; i++)
0309         INIT_HLIST_HEAD(&vp->port_hash[i]);
0310     INIT_LIST_HEAD(&vp->list);
0311     vp->local_mac = *local_mac;
0312
0313     dev->netdev_ops = &vnet_ops;
0314     dev->ethtool_ops = &vnet_ethtool_ops;
0315     dev->watchdog_timeo = VNET_TX_TIMEOUT;
0316
0317     dev->hw_features = NETIF_F_TSO | NETIF_F_GSO | NETIF_F_ALL_TSO |
0318                NETIF_F_HW_CSUM | NETIF_F_SG;
0319     dev->features = dev->hw_features;
0320
0321     /* MTU range: 68 - 65535 */
0322     dev->min_mtu = ETH_MIN_MTU;
0323     dev->max_mtu = VNET_MAX_MTU;
0324
0325     SET_NETDEV_DEV(dev, &vdev->dev);
0326
0327     err = register_netdev(dev);
0328     if (err) {
0329         pr_err("Cannot register net device, aborting\n");
0330         goto err_out_free_dev;
0331     }
0332
0333     netdev_info(dev, "Sun LDOM vnet %pM\n", dev->dev_addr);
0334
0335     list_add(&vp->list, &vnet_list);
0336
0337     return vp;
0338
0339 err_out_free_dev:
0340     free_netdev(dev);
0341
0342     return ERR_PTR(err);
0343 }
0344
0345 static struct vnet *vnet_find_or_create(const u64 *local_mac,
0346                     struct vio_dev *vdev)
0347 {
0348     struct vnet *iter, *vp;
0349
0350     mutex_lock(&vnet_list_mutex);
0351     vp = NULL;
0352     list_for_each_entry(iter, &vnet_list, list) {
0353         if (iter->local_mac == *local_mac) {
0354             vp = iter;
0355             break;
0356         }
0357     }
0358     if (!vp)
0359         vp = vnet_new(local_mac, vdev);
0360     mutex_unlock(&vnet_list_mutex);
0361
0362     return vp;
0363 }
0364
0365 static void vnet_cleanup(void)
0366 {
0367     struct vnet *vp;
0368     struct net_device *dev;
0369
0370     mutex_lock(&vnet_list_mutex);
0371     while (!list_empty(&vnet_list)) {
0372         vp = list_first_entry(&vnet_list, struct vnet, list);
0373         list_del(&vp->list);
0374         dev = vp->dev;
0375         /* vio_unregister_driver() should have cleaned up port_list */
0376         BUG_ON(!list_empty(&vp->port_list));
0377         unregister_netdev(dev);
0378         free_netdev(dev);
0379     }
0380     mutex_unlock(&vnet_list_mutex);
0381 }
0382
0383 static const char *local_mac_prop = "local-mac-address";
0384
0385 static struct vnet *vnet_find_parent(struct mdesc_handle *hp,
0386                      u64 port_node,
0387                      struct vio_dev *vdev)
0388 {
0389     const u64 *local_mac = NULL;
0390     u64 a;
0391
0392     mdesc_for_each_arc(a, hp, port_node, MDESC_ARC_TYPE_BACK) {
0393         u64 target = mdesc_arc_target(hp, a);
0394         const char *name;
0395
0396         name = mdesc_get_property(hp, target, "name", NULL);
0397         if (!name || strcmp(name, "network"))
0398             continue;
0399
0400         local_mac = mdesc_get_property(hp, target,
0401                            local_mac_prop, NULL);
0402         if (local_mac)
0403             break;
0404     }
0405     if (!local_mac)
0406         return ERR_PTR(-ENODEV);
0407
0408     return vnet_find_or_create(local_mac, vdev);
0409 }
0410
0411 static struct ldc_channel_config vnet_ldc_cfg = {
0412     .event      = sunvnet_event_common,
0413     .mtu        = 64,
0414     .mode       = LDC_MODE_UNRELIABLE,
0415 };
0416
0417 static struct vio_driver_ops vnet_vio_ops = {
0418     .send_attr      = sunvnet_send_attr_common,
0419     .handle_attr        = sunvnet_handle_attr_common,
0420     .handshake_complete = sunvnet_handshake_complete_common,
0421 };
0422
0423 const char *remote_macaddr_prop = "remote-mac-address";
0424
0425 static int vnet_port_probe(struct vio_dev *vdev, const struct vio_device_id *id)
0426 {
0427     struct mdesc_handle *hp;
0428     struct vnet_port *port;
0429     unsigned long flags;
0430     struct vnet *vp;
0431     const u64 *rmac;
0432     int len, i, err, switch_port;
0433
0434     hp = mdesc_grab();
0435
0436     vp = vnet_find_parent(hp, vdev->mp, vdev);
0437     if (IS_ERR(vp)) {
0438         pr_err("Cannot find port parent vnet\n");
0439         err = PTR_ERR(vp);
0440         goto err_out_put_mdesc;
0441     }
0442
0443     rmac = mdesc_get_property(hp, vdev->mp, remote_macaddr_prop, &len);
0444     err = -ENODEV;
0445     if (!rmac) {
0446         pr_err("Port lacks %s property\n", remote_macaddr_prop);
0447         goto err_out_put_mdesc;
0448     }
0449
0450     port = kzalloc(sizeof(*port), GFP_KERNEL);
0451     err = -ENOMEM;
0452     if (!port)
0453         goto err_out_put_mdesc;
0454
0455     for (i = 0; i < ETH_ALEN; i++)
0456         port->raddr[i] = (*rmac >> (5 - i) * 8) & 0xff;
0457
0458     port->vp = vp;
0459
0460     err = vio_driver_init(&port->vio, vdev, VDEV_NETWORK,
0461                   vnet_versions, ARRAY_SIZE(vnet_versions),
0462                   &vnet_vio_ops, vp->dev->name);
0463     if (err)
0464         goto err_out_free_port;
0465
0466     err = vio_ldc_alloc(&port->vio, &vnet_ldc_cfg, port);
0467     if (err)
0468         goto err_out_free_port;
0469
0470     netif_napi_add(port->vp->dev, &port->napi, sunvnet_poll_common,
0471                NAPI_POLL_WEIGHT);
0472
0473     INIT_HLIST_NODE(&port->hash);
0474     INIT_LIST_HEAD(&port->list);
0475
0476     switch_port = 0;
0477     if (mdesc_get_property(hp, vdev->mp, "switch-port", NULL))
0478         switch_port = 1;
0479     port->switch_port = switch_port;
0480     port->tso = true;
0481     port->tsolen = 0;
0482
0483     spin_lock_irqsave(&vp->lock, flags);
0484     if (switch_port)
0485         list_add_rcu(&port->list, &vp->port_list);
0486     else
0487         list_add_tail_rcu(&port->list, &vp->port_list);
0488     hlist_add_head_rcu(&port->hash,
0489                &vp->port_hash[vnet_hashfn(port->raddr)]);
0490     sunvnet_port_add_txq_common(port);
0491     spin_unlock_irqrestore(&vp->lock, flags);
0492
0493     dev_set_drvdata(&vdev->dev, port);
0494
0495     pr_info("%s: PORT ( remote-mac %pM%s )\n",
0496         vp->dev->name, port->raddr, switch_port ? " switch-port" : "");
0497
0498     timer_setup(&port->clean_timer, sunvnet_clean_timer_expire_common, 0);
0499
0500     napi_enable(&port->napi);
0501     vio_port_up(&port->vio);
0502
0503     mdesc_release(hp);
0504
0505     return 0;
0506
0507 err_out_free_port:
0508     kfree(port);
0509
0510 err_out_put_mdesc:
0511     mdesc_release(hp);
0512     return err;
0513 }
0514
0515 static void vnet_port_remove(struct vio_dev *vdev)
0516 {
0517     struct vnet_port *port = dev_get_drvdata(&vdev->dev);
0518
0519     if (port) {
0520         del_timer_sync(&port->vio.timer);
0521
0522         napi_disable(&port->napi);
0523
0524         list_del_rcu(&port->list);
0525         hlist_del_rcu(&port->hash);
0526
0527         synchronize_rcu();
0528         del_timer_sync(&port->clean_timer);
0529         sunvnet_port_rm_txq_common(port);
0530         netif_napi_del(&port->napi);
0531         sunvnet_port_free_tx_bufs_common(port);
0532         vio_ldc_free(&port->vio);
0533
0534         dev_set_drvdata(&vdev->dev, NULL);
0535
0536         kfree(port);
0537     }
0538 }
0539
0540 static const struct vio_device_id vnet_port_match[] = {
0541     {
0542         .type = "vnet-port",
0543     },
0544     {},
0545 };
0546 MODULE_DEVICE_TABLE(vio, vnet_port_match);
0547
0548 static struct vio_driver vnet_port_driver = {
0549     .id_table   = vnet_port_match,
0550     .probe      = vnet_port_probe,
0551     .remove     = vnet_port_remove,
0552     .name       = "vnet_port",
0553 };
0554
0555 static int __init vnet_init(void)
0556 {
0557     pr_info("%s\n", version);
0558     return vio_register_driver(&vnet_port_driver);
0559 }
0560
0561 static void __exit vnet_exit(void)
0562 {
0563     vio_unregister_driver(&vnet_port_driver);
0564     vnet_cleanup();
0565 }
0566
0567 module_init(vnet_init);
0568 module_exit(vnet_exit);