drivers/net/can/vxcan.c

   1 /*
   2  * vxcan.c - Virtual CAN Tunnel for cross namespace communication
   3  *
   4  * This code is derived from drivers/net/can/vcan.c for the virtual CAN
   5  * specific parts and from drivers/net/veth.c to implement the netlink API
   6  * for network interface pairs in a common and established way.
   7  *
   8  * Copyright (c) 2017 Oliver Hartkopp <socketcan@hartkopp.net>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the version 2 of the GNU General Public License
  12  * as published by the Free Software Foundation
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/if_arp.h>
  27 #include <linux/if_ether.h>
  28 #include <linux/can.h>
  29 #include <linux/can/dev.h>
  30 #include <linux/can/skb.h>
  31 #include <linux/can/vxcan.h>
  32 #include <linux/slab.h>
  33 #include <net/rtnetlink.h>
  34
  35 #define DRV_NAME "vxcan"
  36
  37 MODULE_DESCRIPTION("Virtual CAN Tunnel");
  38 MODULE_LICENSE("GPL");
  39 MODULE_AUTHOR("Oliver Hartkopp <socketcan@hartkopp.net>");
  40 MODULE_ALIAS_RTNL_LINK(DRV_NAME);
  41
  42 struct vxcan_priv {
  43         struct net_device __rcu *peer;
  44 };
  45
  46 static netdev_tx_t vxcan_xmit(struct sk_buff *skb, struct net_device *dev)
  47 {
  48         struct vxcan_priv *priv = netdev_priv(dev);
  49         struct net_device *peer;
  50         struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
  51         struct net_device_stats *peerstats, *srcstats = &dev->stats;
  52         u8 len;
  53
  54         if (can_dropped_invalid_skb(dev, skb))
  55                 return NETDEV_TX_OK;
  56
  57         rcu_read_lock();
  58         peer = rcu_dereference(priv->peer);
  59         if (unlikely(!peer)) {
  60                 kfree_skb(skb);
  61                 dev->stats.tx_dropped++;
  62                 goto out_unlock;
  63         }
  64
  65         skb = can_create_echo_skb(skb);
  66         if (!skb)
  67                 goto out_unlock;
  68
  69         /* reset CAN GW hop counter */
  70         skb->csum_start = 0;
  71         skb->pkt_type   = PACKET_BROADCAST;
  72         skb->dev        = peer;
  73         skb->ip_summed  = CHECKSUM_UNNECESSARY;
  74
  75         len = cfd->len;
  76         if (netif_rx_ni(skb) == NET_RX_SUCCESS) {
  77                 srcstats->tx_packets++;
  78                 srcstats->tx_bytes += len;
  79                 peerstats = &peer->stats;
  80                 peerstats->rx_packets++;
  81                 peerstats->rx_bytes += len;
  82         }
  83
  84 out_unlock:
  85         rcu_read_unlock();
  86         return NETDEV_TX_OK;
  87 }
  88
  89
  90 static int vxcan_open(struct net_device *dev)
  91 {
  92         struct vxcan_priv *priv = netdev_priv(dev);
  93         struct net_device *peer = rtnl_dereference(priv->peer);
  94
  95         if (!peer)
  96                 return -ENOTCONN;
  97
  98         if (peer->flags & IFF_UP) {
  99                 netif_carrier_on(dev);
 100                 netif_carrier_on(peer);
 101         }
 102         return 0;
 103 }
 104
 105 static int vxcan_close(struct net_device *dev)
 106 {
 107         struct vxcan_priv *priv = netdev_priv(dev);
 108         struct net_device *peer = rtnl_dereference(priv->peer);
 109
 110         netif_carrier_off(dev);
 111         if (peer)
 112                 netif_carrier_off(peer);
 113
 114         return 0;
 115 }
 116
 117 static int vxcan_get_iflink(const struct net_device *dev)
 118 {
 119         struct vxcan_priv *priv = netdev_priv(dev);
 120         struct net_device *peer;
 121         int iflink;
 122
 123         rcu_read_lock();
 124         peer = rcu_dereference(priv->peer);
 125         iflink = peer ? peer->ifindex : 0;
 126         rcu_read_unlock();
 127
 128         return iflink;
 129 }
 130
 131 static int vxcan_change_mtu(struct net_device *dev, int new_mtu)
 132 {
 133         /* Do not allow changing the MTU while running */
 134         if (dev->flags & IFF_UP)
 135                 return -EBUSY;
 136
 137         if (new_mtu != CAN_MTU && new_mtu != CANFD_MTU)
 138                 return -EINVAL;
 139
 140         dev->mtu = new_mtu;
 141         return 0;
 142 }
 143
 144 static const struct net_device_ops vxcan_netdev_ops = {
 145         .ndo_open       = vxcan_open,
 146         .ndo_stop       = vxcan_close,
 147         .ndo_start_xmit = vxcan_xmit,
 148         .ndo_get_iflink = vxcan_get_iflink,
 149         .ndo_change_mtu = vxcan_change_mtu,
 150 };
 151
 152 static void vxcan_setup(struct net_device *dev)
 153 {
 154         dev->type               = ARPHRD_CAN;
 155         dev->mtu                = CANFD_MTU;
 156         dev->hard_header_len    = 0;
 157         dev->addr_len           = 0;
 158         dev->tx_queue_len       = 0;
 159         dev->flags              = IFF_NOARP;
 160         dev->netdev_ops         = &vxcan_netdev_ops;
 161         dev->needs_free_netdev  = true;
 162 }
 163
 164 /* forward declaration for rtnl_create_link() */
 165 static struct rtnl_link_ops vxcan_link_ops;
 166
 167 static int vxcan_newlink(struct net *net, struct net_device *dev,
 168                          struct nlattr *tb[], struct nlattr *data[],
 169                          struct netlink_ext_ack *extack)
 170 {
 171         struct vxcan_priv *priv;
 172         struct net_device *peer;
 173         struct net *peer_net;
 174
 175         struct nlattr *peer_tb[IFLA_MAX + 1], **tbp = tb;
 176         char ifname[IFNAMSIZ];
 177         unsigned char name_assign_type;
 178         struct ifinfomsg *ifmp = NULL;
 179         int err;
 180
 181         /* register peer device */
 182         if (data && data[VXCAN_INFO_PEER]) {
 183                 struct nlattr *nla_peer;
 184
 185                 nla_peer = data[VXCAN_INFO_PEER];
 186                 ifmp = nla_data(nla_peer);
 187                 err = rtnl_nla_parse_ifla(peer_tb,
 188                                           nla_data(nla_peer) +
 189                                           sizeof(struct ifinfomsg),
 190                                           nla_len(nla_peer) -
 191                                           sizeof(struct ifinfomsg),
 192                                           NULL);
 193                 if (err < 0)
 194                         return err;
 195
 196                 tbp = peer_tb;
 197         }
 198
 199         if (ifmp && tbp[IFLA_IFNAME]) {
 200                 nla_strlcpy(ifname, tbp[IFLA_IFNAME], IFNAMSIZ);
 201                 name_assign_type = NET_NAME_USER;
 202         } else {
 203                 snprintf(ifname, IFNAMSIZ, DRV_NAME "%%d");
 204                 name_assign_type = NET_NAME_ENUM;
 205         }
 206
 207         peer_net = rtnl_link_get_net(net, tbp);
 208         if (IS_ERR(peer_net))
 209                 return PTR_ERR(peer_net);
 210
 211         peer = rtnl_create_link(peer_net, ifname, name_assign_type,
 212                                 &vxcan_link_ops, tbp);
 213         if (IS_ERR(peer)) {
 214                 put_net(peer_net);
 215                 return PTR_ERR(peer);
 216         }
 217
 218         if (ifmp && dev->ifindex)
 219                 peer->ifindex = ifmp->ifi_index;
 220
 221         err = register_netdevice(peer);
 222         put_net(peer_net);
 223         peer_net = NULL;
 224         if (err < 0) {
 225                 free_netdev(peer);
 226                 return err;
 227         }
 228
 229         netif_carrier_off(peer);
 230
 231         err = rtnl_configure_link(peer, ifmp);
 232         if (err < 0)
 233                 goto unregister_network_device;
 234
 235         /* register first device */
 236         if (tb[IFLA_IFNAME])
 237                 nla_strlcpy(dev->name, tb[IFLA_IFNAME], IFNAMSIZ);
 238         else
 239                 snprintf(dev->name, IFNAMSIZ, DRV_NAME "%%d");
 240
 241         err = register_netdevice(dev);
 242         if (err < 0)
 243                 goto unregister_network_device;
 244
 245         netif_carrier_off(dev);
 246
 247         /* cross link the device pair */
 248         priv = netdev_priv(dev);
 249         rcu_assign_pointer(priv->peer, peer);
 250
 251         priv = netdev_priv(peer);
 252         rcu_assign_pointer(priv->peer, dev);
 253
 254         return 0;
 255
 256 unregister_network_device:
 257         unregister_netdevice(peer);
 258         return err;
 259 }
 260
 261 static void vxcan_dellink(struct net_device *dev, struct list_head *head)
 262 {
 263         struct vxcan_priv *priv;
 264         struct net_device *peer;
 265
 266         priv = netdev_priv(dev);
 267         peer = rtnl_dereference(priv->peer);
 268
 269         /* Note : dellink() is called from default_device_exit_batch(),
 270          * before a rcu_synchronize() point. The devices are guaranteed
 271          * not being freed before one RCU grace period.
 272          */
 273         RCU_INIT_POINTER(priv->peer, NULL);
 274         unregister_netdevice_queue(dev, head);
 275
 276         if (peer) {
 277                 priv = netdev_priv(peer);
 278                 RCU_INIT_POINTER(priv->peer, NULL);
 279                 unregister_netdevice_queue(peer, head);
 280         }
 281 }
 282
 283 static const struct nla_policy vxcan_policy[VXCAN_INFO_MAX + 1] = {
 284         [VXCAN_INFO_PEER] = { .len = sizeof(struct ifinfomsg) },
 285 };
 286
 287 static struct net *vxcan_get_link_net(const struct net_device *dev)
 288 {
 289         struct vxcan_priv *priv = netdev_priv(dev);
 290         struct net_device *peer = rtnl_dereference(priv->peer);
 291
 292         return peer ? dev_net(peer) : dev_net(dev);
 293 }
 294
 295 static struct rtnl_link_ops vxcan_link_ops = {
 296         .kind           = DRV_NAME,
 297         .priv_size      = sizeof(struct vxcan_priv),
 298         .setup          = vxcan_setup,
 299         .newlink        = vxcan_newlink,
 300         .dellink        = vxcan_dellink,
 301         .policy         = vxcan_policy,
 302         .maxtype        = VXCAN_INFO_MAX,
 303         .get_link_net   = vxcan_get_link_net,
 304 };
 305
 306 static __init int vxcan_init(void)
 307 {
 308         pr_info("vxcan: Virtual CAN Tunnel driver\n");
 309
 310         return rtnl_link_register(&vxcan_link_ops);
 311 }
 312
 313 static __exit void vxcan_exit(void)
 314 {
 315         rtnl_link_unregister(&vxcan_link_ops);
 316 }
 317
 318 module_init(vxcan_init);
 319 module_exit(vxcan_exit);