vport: Extract common functions for virtual devices.
[sliver-openvswitch.git] / datapath / vport-internal_dev.c
1 /*
2  * Copyright (c) 2009, 2010 Nicira Networks.
3  * Distributed under the terms of the GNU GPL version 2.
4  *
5  * Significant portions of this file may be copied from parts of the Linux
6  * kernel, by Linus Torvalds and others.
7  */
8
9 #include <linux/kernel.h>
10 #include <linux/netdevice.h>
11 #include <linux/etherdevice.h>
12 #include <linux/ethtool.h>
13 #include <linux/percpu.h>
14 #include <linux/rcupdate.h>
15 #include <linux/skbuff.h>
16
17 #include "datapath.h"
18 #include "openvswitch/internal_dev.h"
19 #include "vport-generic.h"
20 #include "vport-internal_dev.h"
21 #include "vport-netdev.h"
22
23 struct pcpu_lstats {
24         unsigned long rx_packets;
25         unsigned long rx_bytes;
26         unsigned long tx_packets;
27         unsigned long tx_bytes;
28 };
29
30 struct internal_dev {
31         struct vport *vport;
32
33         struct net_device_stats stats;
34         struct pcpu_lstats *lstats;
35
36         /* This is warty support for XAPI, which does not support summing bond
37          * device statistics itself.  'extra_stats' can be set by userspace via
38          * the DP_DEV_SET_STATS ioctl and, if they are, then they are added to
39          * the real device stats. */
40         struct pcpu_lstats extra_stats;
41 };
42
43 struct vport_ops internal_vport_ops;
44
45 static inline struct internal_dev *internal_dev_priv(struct net_device *netdev)
46 {
47         return netdev_priv(netdev);
48 }
49
50 static struct net_device_stats *internal_dev_get_stats(struct net_device *netdev)
51 {
52         struct internal_dev *internal_dev = internal_dev_priv(netdev);
53         struct net_device_stats *stats;
54         int i;
55
56         stats = &internal_dev->stats;
57         stats->rx_bytes = internal_dev->extra_stats.rx_bytes;
58         stats->rx_packets = internal_dev->extra_stats.rx_packets;
59         stats->tx_bytes = internal_dev->extra_stats.tx_bytes;
60         stats->tx_packets = internal_dev->extra_stats.tx_packets;
61         for_each_possible_cpu(i) {
62                 const struct pcpu_lstats *lb_stats;
63
64                 lb_stats = per_cpu_ptr(internal_dev->lstats, i);
65                 stats->rx_bytes   += lb_stats->rx_bytes;
66                 stats->rx_packets += lb_stats->rx_packets;
67                 stats->tx_bytes   += lb_stats->tx_bytes;
68                 stats->tx_packets += lb_stats->tx_packets;
69         }
70         return stats;
71 }
72
73 static int internal_dev_mac_addr(struct net_device *dev, void *p)
74 {
75         struct sockaddr *addr = p;
76
77         if (!is_valid_ether_addr(addr->sa_data))
78                 return -EADDRNOTAVAIL;
79         memcpy(dev->dev_addr, addr->sa_data, dev->addr_len);
80         return 0;
81 }
82
83 /* Called with rcu_read_lock and bottom-halves disabled. */
84 static int internal_dev_xmit(struct sk_buff *skb, struct net_device *netdev)
85 {
86         struct internal_dev *internal_dev = internal_dev_priv(netdev);
87         struct vport *vport = internal_dev_get_vport(netdev);
88         struct pcpu_lstats *lb_stats;
89
90         /* We need our own clone. */
91         skb = skb_share_check(skb, GFP_ATOMIC);
92         if (!skb)
93                 return 0;
94
95         lb_stats = per_cpu_ptr(internal_dev->lstats, smp_processor_id());
96         lb_stats->tx_packets++;
97         lb_stats->tx_bytes += skb->len;
98
99         skb_reset_mac_header(skb);
100         compute_ip_summed(skb, true);
101
102         vport_receive(vport, skb);
103
104         return 0;
105 }
106
107 static int internal_dev_open(struct net_device *netdev)
108 {
109         netif_start_queue(netdev);
110         return 0;
111 }
112
113 static int internal_dev_stop(struct net_device *netdev)
114 {
115         netif_stop_queue(netdev);
116         return 0;
117 }
118
119 static void internal_dev_getinfo(struct net_device *netdev,
120                                  struct ethtool_drvinfo *info)
121 {
122         struct dp_port *dp_port = vport_get_dp_port(internal_dev_get_vport(netdev));
123
124         strcpy(info->driver, "openvswitch");
125         if (dp_port)
126                 sprintf(info->bus_info, "%d.%d", dp_port->dp->dp_idx, dp_port->port_no);
127 }
128
129 static struct ethtool_ops internal_dev_ethtool_ops = {
130         .get_drvinfo    = internal_dev_getinfo,
131         .get_link       = ethtool_op_get_link,
132         .get_sg         = ethtool_op_get_sg,
133         .set_sg         = ethtool_op_set_sg,
134         .get_tx_csum    = ethtool_op_get_tx_csum,
135         .set_tx_csum    = ethtool_op_set_tx_hw_csum,
136         .get_tso        = ethtool_op_get_tso,
137         .set_tso        = ethtool_op_set_tso,
138 };
139
140 static int internal_dev_change_mtu(struct net_device *netdev, int new_mtu)
141 {
142         struct dp_port *dp_port = vport_get_dp_port(internal_dev_get_vport(netdev));
143
144         if (new_mtu < 68)
145                 return -EINVAL;
146
147         if (dp_port) {
148                 if (new_mtu > dp_min_mtu(dp_port->dp))
149                         return -EINVAL;
150         }
151
152         netdev->mtu = new_mtu;
153         return 0;
154 }
155
156 static int internal_dev_init(struct net_device *netdev)
157 {
158         struct internal_dev *internal_dev = internal_dev_priv(netdev);
159
160         internal_dev->lstats = alloc_percpu(struct pcpu_lstats);
161         if (!internal_dev->lstats)
162                 return -ENOMEM;
163
164         return 0;
165 }
166
167 static void internal_dev_free(struct net_device *netdev)
168 {
169         struct internal_dev *internal_dev = internal_dev_priv(netdev);
170
171         free_percpu(internal_dev->lstats);
172         free_netdev(netdev);
173 }
174
175 static int internal_dev_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
176 {
177         struct internal_dev *internal_dev = internal_dev_priv(dev);
178
179         if (cmd == INTERNAL_DEV_SET_STATS) {
180                 struct internal_dev_stats stats;
181
182                 if (copy_from_user(&stats, ifr->ifr_data, sizeof(stats)))
183                         return -EFAULT;
184
185                 internal_dev->extra_stats.rx_bytes = stats.rx_bytes;
186                 internal_dev->extra_stats.rx_packets = stats.rx_packets;
187                 internal_dev->extra_stats.tx_bytes = stats.tx_bytes;
188                 internal_dev->extra_stats.tx_packets = stats.tx_packets;
189
190                 return 0;
191         }
192
193         if (dp_ioctl_hook)
194                 return dp_ioctl_hook(dev, ifr, cmd);
195         return -EOPNOTSUPP;
196 }
197
198 #ifdef HAVE_NET_DEVICE_OPS
199 static const struct net_device_ops internal_dev_netdev_ops = {
200         .ndo_init = internal_dev_init,
201         .ndo_open = internal_dev_open,
202         .ndo_stop = internal_dev_stop,
203         .ndo_start_xmit = internal_dev_xmit,
204         .ndo_set_mac_address = internal_dev_mac_addr,
205         .ndo_do_ioctl = internal_dev_do_ioctl,
206         .ndo_change_mtu = internal_dev_change_mtu,
207         .ndo_get_stats = internal_dev_get_stats,
208 };
209 #endif
210
211 static void
212 do_setup(struct net_device *netdev)
213 {
214         ether_setup(netdev);
215
216 #ifdef HAVE_NET_DEVICE_OPS
217         netdev->netdev_ops = &internal_dev_netdev_ops;
218 #else
219         netdev->do_ioctl = internal_dev_do_ioctl;
220         netdev->get_stats = internal_dev_get_stats;
221         netdev->hard_start_xmit = internal_dev_xmit;
222         netdev->open = internal_dev_open;
223         netdev->stop = internal_dev_stop;
224         netdev->set_mac_address = internal_dev_mac_addr;
225         netdev->change_mtu = internal_dev_change_mtu;
226         netdev->init = internal_dev_init;
227 #endif
228
229         netdev->destructor = internal_dev_free;
230         SET_ETHTOOL_OPS(netdev, &internal_dev_ethtool_ops);
231         netdev->tx_queue_len = 0;
232
233         netdev->flags = IFF_BROADCAST | IFF_MULTICAST;
234         netdev->features = NETIF_F_LLTX | NETIF_F_SG | NETIF_F_HIGHDMA
235                                 | NETIF_F_HW_CSUM | NETIF_F_TSO;
236
237         vport_gen_rand_ether_addr(netdev->dev_addr);
238 }
239
240 static struct vport *
241 internal_dev_create(const char *name, const void __user *config)
242 {
243         struct vport *vport;
244         struct netdev_vport *netdev_vport;
245         struct internal_dev *internal_dev;
246         int err;
247
248         vport = vport_alloc(sizeof(struct netdev_vport), &internal_vport_ops);
249         if (IS_ERR(vport)) {
250                 err = PTR_ERR(vport);
251                 goto error;
252         }
253
254         netdev_vport = netdev_vport_priv(vport);
255
256         netdev_vport->dev = alloc_netdev(sizeof(struct internal_dev), name, do_setup);
257         if (!netdev_vport->dev) {
258                 err = -ENOMEM;
259                 goto error_free_vport;
260         }
261
262         internal_dev = internal_dev_priv(netdev_vport->dev);
263         internal_dev->vport = vport;
264
265         err = register_netdevice(netdev_vport->dev);
266         if (err)
267                 goto error_free_netdev;
268
269         return vport;
270
271 error_free_netdev:
272         free_netdev(netdev_vport->dev);
273 error_free_vport:
274         vport_free(vport);
275 error:
276         return ERR_PTR(err);
277 }
278
279 static int
280 internal_dev_destroy(struct vport *vport)
281 {
282         struct netdev_vport *netdev_vport = netdev_vport_priv(vport);
283
284         unregister_netdevice(netdev_vport->dev);
285         vport_free(vport);
286
287         return 0;
288 }
289
290 static int
291 internal_dev_attach(struct vport *vport)
292 {
293         struct netdev_vport *netdev_vport = netdev_vport_priv(vport);
294
295         dev_set_promiscuity(netdev_vport->dev, 1);
296
297         /* It would make sense to assign dev->br_port here too, but
298          * that causes packets received on internal ports to get caught
299          * in netdev_frame_hook().  In turn netdev_frame_hook() can reject them
300          * back to the network stack, but that's a waste of time. */
301
302         return 0;
303 }
304
305 static int
306 internal_dev_detach(struct vport *vport)
307 {
308         struct netdev_vport *netdev_vport = netdev_vport_priv(vport);
309
310         dev_set_promiscuity(netdev_vport->dev, -1);
311
312         /* Make sure that no packets arrive from now on, since
313          * internal_dev_xmit() will try to find itself through
314          * p->dp->ports[], and we're about to set that to null. */
315         netif_tx_disable(netdev_vport->dev);
316
317         return 0;
318 }
319
320 static int
321 internal_dev_recv(struct vport *vport, struct sk_buff *skb)
322 {
323         struct net_device *netdev = netdev_vport_priv(vport)->dev;
324         struct internal_dev *internal_dev = internal_dev_priv(netdev);
325         struct pcpu_lstats *lb_stats;
326         int len;
327
328         skb->dev = netdev;
329         len = skb->len;
330         skb->pkt_type = PACKET_HOST;
331         skb->protocol = eth_type_trans(skb, netdev);
332
333         if (in_interrupt())
334                 netif_rx(skb);
335         else
336                 netif_rx_ni(skb);
337         netdev->last_rx = jiffies;
338
339         local_bh_disable();
340         lb_stats = per_cpu_ptr(internal_dev->lstats, smp_processor_id());
341         lb_stats->rx_packets++;
342         lb_stats->rx_bytes += len;
343         local_bh_enable();
344
345         return len;
346 }
347
348 struct vport_ops internal_vport_ops = {
349         .type           = "internal",
350         .flags          = VPORT_F_REQUIRED,
351         .create         = internal_dev_create,
352         .destroy        = internal_dev_destroy,
353         .attach         = internal_dev_attach,
354         .detach         = internal_dev_detach,
355         .set_mtu        = netdev_set_mtu,
356         .set_addr       = netdev_set_addr,
357         .get_name       = netdev_get_name,
358         .get_addr       = netdev_get_addr,
359         .get_kobj       = netdev_get_kobj,
360         .get_stats      = netdev_get_stats,
361         .get_dev_flags  = netdev_get_dev_flags,
362         .is_running     = netdev_is_running,
363         .get_operstate  = netdev_get_operstate,
364         .get_ifindex    = netdev_get_ifindex,
365         .get_iflink     = netdev_get_iflink,
366         .get_mtu        = netdev_get_mtu,
367         .send           = internal_dev_recv,
368 };
369
370 int is_internal_dev(const struct net_device *netdev)
371 {
372 #ifdef HAVE_NET_DEVICE_OPS
373         return netdev->netdev_ops == &internal_dev_netdev_ops;
374 #else
375         return netdev->open == internal_dev_open;
376 #endif
377 }
378
379 int
380 is_internal_vport(const struct vport *vport)
381 {
382         return vport->ops == &internal_vport_ops;
383 }
384
385 struct vport *
386 internal_dev_get_vport(struct net_device *netdev)
387 {
388         struct internal_dev *internal_dev = internal_dev_priv(netdev);
389         return rcu_dereference(internal_dev->vport);
390 }