Skip to content

Commit a8f820a

Browse files
hartkoppmarckleinebudde
authored andcommitted
can: add Virtual CAN Tunnel driver (vxcan)
Similar to the virtual ethernet driver veth, vxcan implements a local CAN traffic tunnel between two virtual CAN network devices. See Kconfig entry for details. Signed-off-by: Oliver Hartkopp <[email protected]> Signed-off-by: Marc Kleine-Budde <[email protected]>
1 parent 1ef8331 commit a8f820a

File tree

4 files changed

+347
-0
lines changed

4 files changed

+347
-0
lines changed

drivers/net/can/Kconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,24 @@ config CAN_VCAN
99
This driver can also be built as a module. If so, the module
1010
will be called vcan.
1111

12+
config CAN_VXCAN
13+
tristate "Virtual CAN Tunnel (vxcan)"
14+
---help---
15+
Similar to the virtual ethernet driver veth, vxcan implements a
16+
local CAN traffic tunnel between two virtual CAN network devices.
17+
When creating a vxcan, two vxcan devices are created as pair.
18+
When one end receives the packet it appears on its pair and vice
19+
versa. The vxcan can be used for cross namespace communication.
20+
21+
In opposite to vcan loopback devices the vxcan only forwards CAN
22+
frames to its pair and does *not* provide a local echo of sent
23+
CAN frames. To disable a potential echo in af_can.c the vxcan driver
24+
announces IFF_ECHO in the interface flags. To have a clean start
25+
in each namespace the CAN GW hop counter is set to zero.
26+
27+
This driver can also be built as a module. If so, the module
28+
will be called vxcan.
29+
1230
config CAN_SLCAN
1331
tristate "Serial / USB serial CAN Adaptors (slcan)"
1432
depends on TTY

drivers/net/can/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#
44

55
obj-$(CONFIG_CAN_VCAN) += vcan.o
6+
obj-$(CONFIG_CAN_VXCAN) += vxcan.o
67
obj-$(CONFIG_CAN_SLCAN) += slcan.o
78

89
obj-$(CONFIG_CAN_DEV) += can-dev.o

drivers/net/can/vxcan.c

Lines changed: 316 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,316 @@
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 <[email protected]>
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 <[email protected]>");
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+
53+
if (can_dropped_invalid_skb(dev, skb))
54+
return NETDEV_TX_OK;
55+
56+
rcu_read_lock();
57+
peer = rcu_dereference(priv->peer);
58+
if (unlikely(!peer)) {
59+
kfree_skb(skb);
60+
dev->stats.tx_dropped++;
61+
goto out_unlock;
62+
}
63+
64+
skb = can_create_echo_skb(skb);
65+
if (!skb)
66+
goto out_unlock;
67+
68+
/* reset CAN GW hop counter */
69+
skb->csum_start = 0;
70+
skb->pkt_type = PACKET_BROADCAST;
71+
skb->dev = peer;
72+
skb->ip_summed = CHECKSUM_UNNECESSARY;
73+
74+
if (netif_rx_ni(skb) == NET_RX_SUCCESS) {
75+
srcstats->tx_packets++;
76+
srcstats->tx_bytes += cfd->len;
77+
peerstats = &peer->stats;
78+
peerstats->rx_packets++;
79+
peerstats->rx_bytes += cfd->len;
80+
}
81+
82+
out_unlock:
83+
rcu_read_unlock();
84+
return NETDEV_TX_OK;
85+
}
86+
87+
88+
static int vxcan_open(struct net_device *dev)
89+
{
90+
struct vxcan_priv *priv = netdev_priv(dev);
91+
struct net_device *peer = rtnl_dereference(priv->peer);
92+
93+
if (!peer)
94+
return -ENOTCONN;
95+
96+
if (peer->flags & IFF_UP) {
97+
netif_carrier_on(dev);
98+
netif_carrier_on(peer);
99+
}
100+
return 0;
101+
}
102+
103+
static int vxcan_close(struct net_device *dev)
104+
{
105+
struct vxcan_priv *priv = netdev_priv(dev);
106+
struct net_device *peer = rtnl_dereference(priv->peer);
107+
108+
netif_carrier_off(dev);
109+
if (peer)
110+
netif_carrier_off(peer);
111+
112+
return 0;
113+
}
114+
115+
static int vxcan_get_iflink(const struct net_device *dev)
116+
{
117+
struct vxcan_priv *priv = netdev_priv(dev);
118+
struct net_device *peer;
119+
int iflink;
120+
121+
rcu_read_lock();
122+
peer = rcu_dereference(priv->peer);
123+
iflink = peer ? peer->ifindex : 0;
124+
rcu_read_unlock();
125+
126+
return iflink;
127+
}
128+
129+
static int vxcan_change_mtu(struct net_device *dev, int new_mtu)
130+
{
131+
/* Do not allow changing the MTU while running */
132+
if (dev->flags & IFF_UP)
133+
return -EBUSY;
134+
135+
if (new_mtu != CAN_MTU && new_mtu != CANFD_MTU)
136+
return -EINVAL;
137+
138+
dev->mtu = new_mtu;
139+
return 0;
140+
}
141+
142+
static const struct net_device_ops vxcan_netdev_ops = {
143+
.ndo_open = vxcan_open,
144+
.ndo_stop = vxcan_close,
145+
.ndo_start_xmit = vxcan_xmit,
146+
.ndo_get_iflink = vxcan_get_iflink,
147+
.ndo_change_mtu = vxcan_change_mtu,
148+
};
149+
150+
static void vxcan_setup(struct net_device *dev)
151+
{
152+
dev->type = ARPHRD_CAN;
153+
dev->mtu = CAN_MTU;
154+
dev->hard_header_len = 0;
155+
dev->addr_len = 0;
156+
dev->tx_queue_len = 0;
157+
dev->flags = (IFF_NOARP|IFF_ECHO);
158+
dev->netdev_ops = &vxcan_netdev_ops;
159+
dev->destructor = free_netdev;
160+
}
161+
162+
/* forward declaration for rtnl_create_link() */
163+
static struct rtnl_link_ops vxcan_link_ops;
164+
165+
static int vxcan_newlink(struct net *net, struct net_device *dev,
166+
struct nlattr *tb[], struct nlattr *data[])
167+
{
168+
struct vxcan_priv *priv;
169+
struct net_device *peer;
170+
struct net *peer_net;
171+
172+
struct nlattr *peer_tb[IFLA_MAX + 1], **tbp = tb;
173+
char ifname[IFNAMSIZ];
174+
unsigned char name_assign_type;
175+
struct ifinfomsg *ifmp = NULL;
176+
int err;
177+
178+
/* register peer device */
179+
if (data && data[VXCAN_INFO_PEER]) {
180+
struct nlattr *nla_peer;
181+
182+
nla_peer = data[VXCAN_INFO_PEER];
183+
ifmp = nla_data(nla_peer);
184+
err = rtnl_nla_parse_ifla(peer_tb,
185+
nla_data(nla_peer) +
186+
sizeof(struct ifinfomsg),
187+
nla_len(nla_peer) -
188+
sizeof(struct ifinfomsg),
189+
NULL);
190+
if (err < 0)
191+
return err;
192+
193+
tbp = peer_tb;
194+
}
195+
196+
if (tbp[IFLA_IFNAME]) {
197+
nla_strlcpy(ifname, tbp[IFLA_IFNAME], IFNAMSIZ);
198+
name_assign_type = NET_NAME_USER;
199+
} else {
200+
snprintf(ifname, IFNAMSIZ, DRV_NAME "%%d");
201+
name_assign_type = NET_NAME_ENUM;
202+
}
203+
204+
peer_net = rtnl_link_get_net(net, tbp);
205+
if (IS_ERR(peer_net))
206+
return PTR_ERR(peer_net);
207+
208+
peer = rtnl_create_link(peer_net, ifname, name_assign_type,
209+
&vxcan_link_ops, tbp);
210+
if (IS_ERR(peer)) {
211+
put_net(peer_net);
212+
return PTR_ERR(peer);
213+
}
214+
215+
if (ifmp && dev->ifindex)
216+
peer->ifindex = ifmp->ifi_index;
217+
218+
err = register_netdevice(peer);
219+
put_net(peer_net);
220+
peer_net = NULL;
221+
if (err < 0) {
222+
free_netdev(peer);
223+
return err;
224+
}
225+
226+
netif_carrier_off(peer);
227+
228+
err = rtnl_configure_link(peer, ifmp);
229+
if (err < 0) {
230+
unregister_netdevice(peer);
231+
return err;
232+
}
233+
234+
/* register first device */
235+
if (tb[IFLA_IFNAME])
236+
nla_strlcpy(dev->name, tb[IFLA_IFNAME], IFNAMSIZ);
237+
else
238+
snprintf(dev->name, IFNAMSIZ, DRV_NAME "%%d");
239+
240+
err = register_netdevice(dev);
241+
if (err < 0) {
242+
unregister_netdevice(peer);
243+
return err;
244+
}
245+
246+
netif_carrier_off(dev);
247+
248+
/* cross link the device pair */
249+
priv = netdev_priv(dev);
250+
rcu_assign_pointer(priv->peer, peer);
251+
252+
priv = netdev_priv(peer);
253+
rcu_assign_pointer(priv->peer, dev);
254+
255+
return 0;
256+
}
257+
258+
static void vxcan_dellink(struct net_device *dev, struct list_head *head)
259+
{
260+
struct vxcan_priv *priv;
261+
struct net_device *peer;
262+
263+
priv = netdev_priv(dev);
264+
peer = rtnl_dereference(priv->peer);
265+
266+
/* Note : dellink() is called from default_device_exit_batch(),
267+
* before a rcu_synchronize() point. The devices are guaranteed
268+
* not being freed before one RCU grace period.
269+
*/
270+
RCU_INIT_POINTER(priv->peer, NULL);
271+
unregister_netdevice_queue(dev, head);
272+
273+
if (peer) {
274+
priv = netdev_priv(peer);
275+
RCU_INIT_POINTER(priv->peer, NULL);
276+
unregister_netdevice_queue(peer, head);
277+
}
278+
}
279+
280+
static const struct nla_policy vxcan_policy[VXCAN_INFO_MAX + 1] = {
281+
[VXCAN_INFO_PEER] = { .len = sizeof(struct ifinfomsg) },
282+
};
283+
284+
static struct net *vxcan_get_link_net(const struct net_device *dev)
285+
{
286+
struct vxcan_priv *priv = netdev_priv(dev);
287+
struct net_device *peer = rtnl_dereference(priv->peer);
288+
289+
return peer ? dev_net(peer) : dev_net(dev);
290+
}
291+
292+
static struct rtnl_link_ops vxcan_link_ops = {
293+
.kind = DRV_NAME,
294+
.priv_size = sizeof(struct vxcan_priv),
295+
.setup = vxcan_setup,
296+
.newlink = vxcan_newlink,
297+
.dellink = vxcan_dellink,
298+
.policy = vxcan_policy,
299+
.maxtype = VXCAN_INFO_MAX,
300+
.get_link_net = vxcan_get_link_net,
301+
};
302+
303+
static __init int vxcan_init(void)
304+
{
305+
pr_info("vxcan: Virtual CAN Tunnel driver\n");
306+
307+
return rtnl_link_register(&vxcan_link_ops);
308+
}
309+
310+
static __exit void vxcan_exit(void)
311+
{
312+
rtnl_link_unregister(&vxcan_link_ops);
313+
}
314+
315+
module_init(vxcan_init);
316+
module_exit(vxcan_exit);

include/uapi/linux/can/vxcan.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#ifndef _UAPI_CAN_VXCAN_H
2+
#define _UAPI_CAN_VXCAN_H
3+
4+
enum {
5+
VXCAN_INFO_UNSPEC,
6+
VXCAN_INFO_PEER,
7+
8+
__VXCAN_INFO_MAX
9+
#define VXCAN_INFO_MAX (__VXCAN_INFO_MAX - 1)
10+
};
11+
12+
#endif

0 commit comments

Comments
 (0)