]> Pileus Git - ~andy/linux/blob - drivers/net/macvtap.c
macvtap: Perform GSO on forwarding path.
[~andy/linux] / drivers / net / macvtap.c
1 #include <linux/etherdevice.h>
2 #include <linux/if_macvlan.h>
3 #include <linux/if_vlan.h>
4 #include <linux/interrupt.h>
5 #include <linux/nsproxy.h>
6 #include <linux/compat.h>
7 #include <linux/if_tun.h>
8 #include <linux/module.h>
9 #include <linux/skbuff.h>
10 #include <linux/cache.h>
11 #include <linux/sched.h>
12 #include <linux/types.h>
13 #include <linux/slab.h>
14 #include <linux/init.h>
15 #include <linux/wait.h>
16 #include <linux/cdev.h>
17 #include <linux/idr.h>
18 #include <linux/fs.h>
19
20 #include <net/net_namespace.h>
21 #include <net/rtnetlink.h>
22 #include <net/sock.h>
23 #include <linux/virtio_net.h>
24
25 /*
26  * A macvtap queue is the central object of this driver, it connects
27  * an open character device to a macvlan interface. There can be
28  * multiple queues on one interface, which map back to queues
29  * implemented in hardware on the underlying device.
30  *
31  * macvtap_proto is used to allocate queues through the sock allocation
32  * mechanism.
33  *
34  */
35 struct macvtap_queue {
36         struct sock sk;
37         struct socket sock;
38         struct socket_wq wq;
39         int vnet_hdr_sz;
40         struct macvlan_dev __rcu *vlan;
41         struct file *file;
42         unsigned int flags;
43         u16 queue_index;
44         bool enabled;
45         struct list_head next;
46 };
47
48 static struct proto macvtap_proto = {
49         .name = "macvtap",
50         .owner = THIS_MODULE,
51         .obj_size = sizeof (struct macvtap_queue),
52 };
53
54 /*
55  * Variables for dealing with macvtaps device numbers.
56  */
57 static dev_t macvtap_major;
58 #define MACVTAP_NUM_DEVS (1U << MINORBITS)
59 static DEFINE_MUTEX(minor_lock);
60 static DEFINE_IDR(minor_idr);
61
62 #define GOODCOPY_LEN 128
63 static struct class *macvtap_class;
64 static struct cdev macvtap_cdev;
65
66 static const struct proto_ops macvtap_socket_ops;
67
68 #define TUN_OFFLOADS (NETIF_F_HW_CSUM | NETIF_F_TSO_ECN | NETIF_F_TSO | \
69                       NETIF_F_TSO6 | NETIF_F_UFO)
70 #define RX_OFFLOADS (NETIF_F_GRO | NETIF_F_LRO)
71 /*
72  * RCU usage:
73  * The macvtap_queue and the macvlan_dev are loosely coupled, the
74  * pointers from one to the other can only be read while rcu_read_lock
75  * or rtnl is held.
76  *
77  * Both the file and the macvlan_dev hold a reference on the macvtap_queue
78  * through sock_hold(&q->sk). When the macvlan_dev goes away first,
79  * q->vlan becomes inaccessible. When the files gets closed,
80  * macvtap_get_queue() fails.
81  *
82  * There may still be references to the struct sock inside of the
83  * queue from outbound SKBs, but these never reference back to the
84  * file or the dev. The data structure is freed through __sk_free
85  * when both our references and any pending SKBs are gone.
86  */
87
88 static int macvtap_enable_queue(struct net_device *dev, struct file *file,
89                                 struct macvtap_queue *q)
90 {
91         struct macvlan_dev *vlan = netdev_priv(dev);
92         int err = -EINVAL;
93
94         ASSERT_RTNL();
95
96         if (q->enabled)
97                 goto out;
98
99         err = 0;
100         rcu_assign_pointer(vlan->taps[vlan->numvtaps], q);
101         q->queue_index = vlan->numvtaps;
102         q->enabled = true;
103
104         vlan->numvtaps++;
105 out:
106         return err;
107 }
108
109 static int macvtap_set_queue(struct net_device *dev, struct file *file,
110                              struct macvtap_queue *q)
111 {
112         struct macvlan_dev *vlan = netdev_priv(dev);
113         int err = -EBUSY;
114
115         rtnl_lock();
116         if (vlan->numqueues == MAX_MACVTAP_QUEUES)
117                 goto out;
118
119         err = 0;
120         rcu_assign_pointer(q->vlan, vlan);
121         rcu_assign_pointer(vlan->taps[vlan->numvtaps], q);
122         sock_hold(&q->sk);
123
124         q->file = file;
125         q->queue_index = vlan->numvtaps;
126         q->enabled = true;
127         file->private_data = q;
128         list_add_tail(&q->next, &vlan->queue_list);
129
130         vlan->numvtaps++;
131         vlan->numqueues++;
132
133 out:
134         rtnl_unlock();
135         return err;
136 }
137
138 static int macvtap_disable_queue(struct macvtap_queue *q)
139 {
140         struct macvlan_dev *vlan;
141         struct macvtap_queue *nq;
142
143         ASSERT_RTNL();
144         if (!q->enabled)
145                 return -EINVAL;
146
147         vlan = rtnl_dereference(q->vlan);
148
149         if (vlan) {
150                 int index = q->queue_index;
151                 BUG_ON(index >= vlan->numvtaps);
152                 nq = rtnl_dereference(vlan->taps[vlan->numvtaps - 1]);
153                 nq->queue_index = index;
154
155                 rcu_assign_pointer(vlan->taps[index], nq);
156                 RCU_INIT_POINTER(vlan->taps[vlan->numvtaps - 1], NULL);
157                 q->enabled = false;
158
159                 vlan->numvtaps--;
160         }
161
162         return 0;
163 }
164
165 /*
166  * The file owning the queue got closed, give up both
167  * the reference that the files holds as well as the
168  * one from the macvlan_dev if that still exists.
169  *
170  * Using the spinlock makes sure that we don't get
171  * to the queue again after destroying it.
172  */
173 static void macvtap_put_queue(struct macvtap_queue *q)
174 {
175         struct macvlan_dev *vlan;
176
177         rtnl_lock();
178         vlan = rtnl_dereference(q->vlan);
179
180         if (vlan) {
181                 if (q->enabled)
182                         BUG_ON(macvtap_disable_queue(q));
183
184                 vlan->numqueues--;
185                 RCU_INIT_POINTER(q->vlan, NULL);
186                 sock_put(&q->sk);
187                 list_del_init(&q->next);
188         }
189
190         rtnl_unlock();
191
192         synchronize_rcu();
193         sock_put(&q->sk);
194 }
195
196 /*
197  * Select a queue based on the rxq of the device on which this packet
198  * arrived. If the incoming device is not mq, calculate a flow hash
199  * to select a queue. If all fails, find the first available queue.
200  * Cache vlan->numvtaps since it can become zero during the execution
201  * of this function.
202  */
203 static struct macvtap_queue *macvtap_get_queue(struct net_device *dev,
204                                                struct sk_buff *skb)
205 {
206         struct macvlan_dev *vlan = netdev_priv(dev);
207         struct macvtap_queue *tap = NULL;
208         /* Access to taps array is protected by rcu, but access to numvtaps
209          * isn't. Below we use it to lookup a queue, but treat it as a hint
210          * and validate that the result isn't NULL - in case we are
211          * racing against queue removal.
212          */
213         int numvtaps = ACCESS_ONCE(vlan->numvtaps);
214         __u32 rxq;
215
216         if (!numvtaps)
217                 goto out;
218
219         /* Check if we can use flow to select a queue */
220         rxq = skb_get_rxhash(skb);
221         if (rxq) {
222                 tap = rcu_dereference(vlan->taps[rxq % numvtaps]);
223                 goto out;
224         }
225
226         if (likely(skb_rx_queue_recorded(skb))) {
227                 rxq = skb_get_rx_queue(skb);
228
229                 while (unlikely(rxq >= numvtaps))
230                         rxq -= numvtaps;
231
232                 tap = rcu_dereference(vlan->taps[rxq]);
233                 goto out;
234         }
235
236         tap = rcu_dereference(vlan->taps[0]);
237 out:
238         return tap;
239 }
240
241 /*
242  * The net_device is going away, give up the reference
243  * that it holds on all queues and safely set the pointer
244  * from the queues to NULL.
245  */
246 static void macvtap_del_queues(struct net_device *dev)
247 {
248         struct macvlan_dev *vlan = netdev_priv(dev);
249         struct macvtap_queue *q, *tmp, *qlist[MAX_MACVTAP_QUEUES];
250         int i, j = 0;
251
252         ASSERT_RTNL();
253         list_for_each_entry_safe(q, tmp, &vlan->queue_list, next) {
254                 list_del_init(&q->next);
255                 qlist[j++] = q;
256                 RCU_INIT_POINTER(q->vlan, NULL);
257                 if (q->enabled)
258                         vlan->numvtaps--;
259                 vlan->numqueues--;
260         }
261         for (i = 0; i < vlan->numvtaps; i++)
262                 RCU_INIT_POINTER(vlan->taps[i], NULL);
263         BUG_ON(vlan->numvtaps);
264         BUG_ON(vlan->numqueues);
265         /* guarantee that any future macvtap_set_queue will fail */
266         vlan->numvtaps = MAX_MACVTAP_QUEUES;
267
268         for (--j; j >= 0; j--)
269                 sock_put(&qlist[j]->sk);
270 }
271
272 /*
273  * Forward happens for data that gets sent from one macvlan
274  * endpoint to another one in bridge mode. We just take
275  * the skb and put it into the receive queue.
276  */
277 static int macvtap_forward(struct net_device *dev, struct sk_buff *skb)
278 {
279         struct macvlan_dev *vlan = netdev_priv(dev);
280         struct macvtap_queue *q = macvtap_get_queue(dev, skb);
281         netdev_features_t features;
282         if (!q)
283                 goto drop;
284
285         if (skb_queue_len(&q->sk.sk_receive_queue) >= dev->tx_queue_len)
286                 goto drop;
287
288         skb->dev = dev;
289         /* Apply the forward feature mask so that we perform segmentation
290          * according to users wishes.
291          */
292         features = netif_skb_features(skb) & vlan->tap_features;
293         if (netif_needs_gso(skb, features)) {
294                 struct sk_buff *segs = __skb_gso_segment(skb, features, false);
295
296                 if (IS_ERR(segs))
297                         goto drop;
298
299                 if (!segs) {
300                         skb_queue_tail(&q->sk.sk_receive_queue, skb);
301                         goto wake_up;
302                 }
303
304                 kfree_skb(skb);
305                 while (segs) {
306                         struct sk_buff *nskb = segs->next;
307
308                         segs->next = NULL;
309                         skb_queue_tail(&q->sk.sk_receive_queue, segs);
310                         segs = nskb;
311                 }
312         } else {
313                 skb_queue_tail(&q->sk.sk_receive_queue, skb);
314         }
315
316 wake_up:
317         wake_up_interruptible_poll(sk_sleep(&q->sk), POLLIN | POLLRDNORM | POLLRDBAND);
318         return NET_RX_SUCCESS;
319
320 drop:
321         kfree_skb(skb);
322         return NET_RX_DROP;
323 }
324
325 /*
326  * Receive is for data from the external interface (lowerdev),
327  * in case of macvtap, we can treat that the same way as
328  * forward, which macvlan cannot.
329  */
330 static int macvtap_receive(struct sk_buff *skb)
331 {
332         skb_push(skb, ETH_HLEN);
333         return macvtap_forward(skb->dev, skb);
334 }
335
336 static int macvtap_get_minor(struct macvlan_dev *vlan)
337 {
338         int retval = -ENOMEM;
339
340         mutex_lock(&minor_lock);
341         retval = idr_alloc(&minor_idr, vlan, 1, MACVTAP_NUM_DEVS, GFP_KERNEL);
342         if (retval >= 0) {
343                 vlan->minor = retval;
344         } else if (retval == -ENOSPC) {
345                 printk(KERN_ERR "too many macvtap devices\n");
346                 retval = -EINVAL;
347         }
348         mutex_unlock(&minor_lock);
349         return retval < 0 ? retval : 0;
350 }
351
352 static void macvtap_free_minor(struct macvlan_dev *vlan)
353 {
354         mutex_lock(&minor_lock);
355         if (vlan->minor) {
356                 idr_remove(&minor_idr, vlan->minor);
357                 vlan->minor = 0;
358         }
359         mutex_unlock(&minor_lock);
360 }
361
362 static struct net_device *dev_get_by_macvtap_minor(int minor)
363 {
364         struct net_device *dev = NULL;
365         struct macvlan_dev *vlan;
366
367         mutex_lock(&minor_lock);
368         vlan = idr_find(&minor_idr, minor);
369         if (vlan) {
370                 dev = vlan->dev;
371                 dev_hold(dev);
372         }
373         mutex_unlock(&minor_lock);
374         return dev;
375 }
376
377 static int macvtap_newlink(struct net *src_net,
378                            struct net_device *dev,
379                            struct nlattr *tb[],
380                            struct nlattr *data[])
381 {
382         struct macvlan_dev *vlan = netdev_priv(dev);
383         INIT_LIST_HEAD(&vlan->queue_list);
384
385         /* Since macvlan supports all offloads by default, make
386          * tap support all offloads also.
387          */
388         vlan->tap_features = TUN_OFFLOADS;
389
390         /* Don't put anything that may fail after macvlan_common_newlink
391          * because we can't undo what it does.
392          */
393         return macvlan_common_newlink(src_net, dev, tb, data,
394                                       macvtap_receive, macvtap_forward);
395 }
396
397 static void macvtap_dellink(struct net_device *dev,
398                             struct list_head *head)
399 {
400         macvtap_del_queues(dev);
401         macvlan_dellink(dev, head);
402 }
403
404 static void macvtap_setup(struct net_device *dev)
405 {
406         macvlan_common_setup(dev);
407         dev->tx_queue_len = TUN_READQ_SIZE;
408 }
409
410 static struct rtnl_link_ops macvtap_link_ops __read_mostly = {
411         .kind           = "macvtap",
412         .setup          = macvtap_setup,
413         .newlink        = macvtap_newlink,
414         .dellink        = macvtap_dellink,
415 };
416
417
418 static void macvtap_sock_write_space(struct sock *sk)
419 {
420         wait_queue_head_t *wqueue;
421
422         if (!sock_writeable(sk) ||
423             !test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags))
424                 return;
425
426         wqueue = sk_sleep(sk);
427         if (wqueue && waitqueue_active(wqueue))
428                 wake_up_interruptible_poll(wqueue, POLLOUT | POLLWRNORM | POLLWRBAND);
429 }
430
431 static void macvtap_sock_destruct(struct sock *sk)
432 {
433         skb_queue_purge(&sk->sk_receive_queue);
434 }
435
436 static int macvtap_open(struct inode *inode, struct file *file)
437 {
438         struct net *net = current->nsproxy->net_ns;
439         struct net_device *dev = dev_get_by_macvtap_minor(iminor(inode));
440         struct macvtap_queue *q;
441         int err;
442
443         err = -ENODEV;
444         if (!dev)
445                 goto out;
446
447         err = -ENOMEM;
448         q = (struct macvtap_queue *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
449                                              &macvtap_proto);
450         if (!q)
451                 goto out;
452
453         RCU_INIT_POINTER(q->sock.wq, &q->wq);
454         init_waitqueue_head(&q->wq.wait);
455         q->sock.type = SOCK_RAW;
456         q->sock.state = SS_CONNECTED;
457         q->sock.file = file;
458         q->sock.ops = &macvtap_socket_ops;
459         sock_init_data(&q->sock, &q->sk);
460         q->sk.sk_write_space = macvtap_sock_write_space;
461         q->sk.sk_destruct = macvtap_sock_destruct;
462         q->flags = IFF_VNET_HDR | IFF_NO_PI | IFF_TAP;
463         q->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
464
465         /*
466          * so far only KVM virtio_net uses macvtap, enable zero copy between
467          * guest kernel and host kernel when lower device supports zerocopy
468          *
469          * The macvlan supports zerocopy iff the lower device supports zero
470          * copy so we don't have to look at the lower device directly.
471          */
472         if ((dev->features & NETIF_F_HIGHDMA) && (dev->features & NETIF_F_SG))
473                 sock_set_flag(&q->sk, SOCK_ZEROCOPY);
474
475         err = macvtap_set_queue(dev, file, q);
476         if (err)
477                 sock_put(&q->sk);
478
479 out:
480         if (dev)
481                 dev_put(dev);
482
483         return err;
484 }
485
486 static int macvtap_release(struct inode *inode, struct file *file)
487 {
488         struct macvtap_queue *q = file->private_data;
489         macvtap_put_queue(q);
490         return 0;
491 }
492
493 static unsigned int macvtap_poll(struct file *file, poll_table * wait)
494 {
495         struct macvtap_queue *q = file->private_data;
496         unsigned int mask = POLLERR;
497
498         if (!q)
499                 goto out;
500
501         mask = 0;
502         poll_wait(file, &q->wq.wait, wait);
503
504         if (!skb_queue_empty(&q->sk.sk_receive_queue))
505                 mask |= POLLIN | POLLRDNORM;
506
507         if (sock_writeable(&q->sk) ||
508             (!test_and_set_bit(SOCK_ASYNC_NOSPACE, &q->sock.flags) &&
509              sock_writeable(&q->sk)))
510                 mask |= POLLOUT | POLLWRNORM;
511
512 out:
513         return mask;
514 }
515
516 static inline struct sk_buff *macvtap_alloc_skb(struct sock *sk, size_t prepad,
517                                                 size_t len, size_t linear,
518                                                 int noblock, int *err)
519 {
520         struct sk_buff *skb;
521
522         /* Under a page?  Don't bother with paged skb. */
523         if (prepad + len < PAGE_SIZE || !linear)
524                 linear = len;
525
526         skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
527                                    err);
528         if (!skb)
529                 return NULL;
530
531         skb_reserve(skb, prepad);
532         skb_put(skb, linear);
533         skb->data_len = len - linear;
534         skb->len += len - linear;
535
536         return skb;
537 }
538
539 /* set skb frags from iovec, this can move to core network code for reuse */
540 static int zerocopy_sg_from_iovec(struct sk_buff *skb, const struct iovec *from,
541                                   int offset, size_t count)
542 {
543         int len = iov_length(from, count) - offset;
544         int copy = skb_headlen(skb);
545         int size, offset1 = 0;
546         int i = 0;
547
548         /* Skip over from offset */
549         while (count && (offset >= from->iov_len)) {
550                 offset -= from->iov_len;
551                 ++from;
552                 --count;
553         }
554
555         /* copy up to skb headlen */
556         while (count && (copy > 0)) {
557                 size = min_t(unsigned int, copy, from->iov_len - offset);
558                 if (copy_from_user(skb->data + offset1, from->iov_base + offset,
559                                    size))
560                         return -EFAULT;
561                 if (copy > size) {
562                         ++from;
563                         --count;
564                         offset = 0;
565                 } else
566                         offset += size;
567                 copy -= size;
568                 offset1 += size;
569         }
570
571         if (len == offset1)
572                 return 0;
573
574         while (count--) {
575                 struct page *page[MAX_SKB_FRAGS];
576                 int num_pages;
577                 unsigned long base;
578                 unsigned long truesize;
579
580                 len = from->iov_len - offset;
581                 if (!len) {
582                         offset = 0;
583                         ++from;
584                         continue;
585                 }
586                 base = (unsigned long)from->iov_base + offset;
587                 size = ((base & ~PAGE_MASK) + len + ~PAGE_MASK) >> PAGE_SHIFT;
588                 if (i + size > MAX_SKB_FRAGS)
589                         return -EMSGSIZE;
590                 num_pages = get_user_pages_fast(base, size, 0, &page[i]);
591                 if (num_pages != size) {
592                         for (i = 0; i < num_pages; i++)
593                                 put_page(page[i]);
594                         return -EFAULT;
595                 }
596                 truesize = size * PAGE_SIZE;
597                 skb->data_len += len;
598                 skb->len += len;
599                 skb->truesize += truesize;
600                 atomic_add(truesize, &skb->sk->sk_wmem_alloc);
601                 while (len) {
602                         int off = base & ~PAGE_MASK;
603                         int size = min_t(int, len, PAGE_SIZE - off);
604                         __skb_fill_page_desc(skb, i, page[i], off, size);
605                         skb_shinfo(skb)->nr_frags++;
606                         /* increase sk_wmem_alloc */
607                         base += size;
608                         len -= size;
609                         i++;
610                 }
611                 offset = 0;
612                 ++from;
613         }
614         return 0;
615 }
616
617 /*
618  * macvtap_skb_from_vnet_hdr and macvtap_skb_to_vnet_hdr should
619  * be shared with the tun/tap driver.
620  */
621 static int macvtap_skb_from_vnet_hdr(struct sk_buff *skb,
622                                      struct virtio_net_hdr *vnet_hdr)
623 {
624         unsigned short gso_type = 0;
625         if (vnet_hdr->gso_type != VIRTIO_NET_HDR_GSO_NONE) {
626                 switch (vnet_hdr->gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
627                 case VIRTIO_NET_HDR_GSO_TCPV4:
628                         gso_type = SKB_GSO_TCPV4;
629                         break;
630                 case VIRTIO_NET_HDR_GSO_TCPV6:
631                         gso_type = SKB_GSO_TCPV6;
632                         break;
633                 case VIRTIO_NET_HDR_GSO_UDP:
634                         gso_type = SKB_GSO_UDP;
635                         break;
636                 default:
637                         return -EINVAL;
638                 }
639
640                 if (vnet_hdr->gso_type & VIRTIO_NET_HDR_GSO_ECN)
641                         gso_type |= SKB_GSO_TCP_ECN;
642
643                 if (vnet_hdr->gso_size == 0)
644                         return -EINVAL;
645         }
646
647         if (vnet_hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) {
648                 if (!skb_partial_csum_set(skb, vnet_hdr->csum_start,
649                                           vnet_hdr->csum_offset))
650                         return -EINVAL;
651         }
652
653         if (vnet_hdr->gso_type != VIRTIO_NET_HDR_GSO_NONE) {
654                 skb_shinfo(skb)->gso_size = vnet_hdr->gso_size;
655                 skb_shinfo(skb)->gso_type = gso_type;
656
657                 /* Header must be checked, and gso_segs computed. */
658                 skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
659                 skb_shinfo(skb)->gso_segs = 0;
660         }
661         return 0;
662 }
663
664 static int macvtap_skb_to_vnet_hdr(const struct sk_buff *skb,
665                                    struct virtio_net_hdr *vnet_hdr)
666 {
667         memset(vnet_hdr, 0, sizeof(*vnet_hdr));
668
669         if (skb_is_gso(skb)) {
670                 struct skb_shared_info *sinfo = skb_shinfo(skb);
671
672                 /* This is a hint as to how much should be linear. */
673                 vnet_hdr->hdr_len = skb_headlen(skb);
674                 vnet_hdr->gso_size = sinfo->gso_size;
675                 if (sinfo->gso_type & SKB_GSO_TCPV4)
676                         vnet_hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
677                 else if (sinfo->gso_type & SKB_GSO_TCPV6)
678                         vnet_hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
679                 else if (sinfo->gso_type & SKB_GSO_UDP)
680                         vnet_hdr->gso_type = VIRTIO_NET_HDR_GSO_UDP;
681                 else
682                         BUG();
683                 if (sinfo->gso_type & SKB_GSO_TCP_ECN)
684                         vnet_hdr->gso_type |= VIRTIO_NET_HDR_GSO_ECN;
685         } else
686                 vnet_hdr->gso_type = VIRTIO_NET_HDR_GSO_NONE;
687
688         if (skb->ip_summed == CHECKSUM_PARTIAL) {
689                 vnet_hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
690                 vnet_hdr->csum_start = skb_checksum_start_offset(skb);
691                 vnet_hdr->csum_offset = skb->csum_offset;
692         } else if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
693                 vnet_hdr->flags = VIRTIO_NET_HDR_F_DATA_VALID;
694         } /* else everything is zero */
695
696         return 0;
697 }
698
699
700 /* Get packet from user space buffer */
701 static ssize_t macvtap_get_user(struct macvtap_queue *q, struct msghdr *m,
702                                 const struct iovec *iv, unsigned long total_len,
703                                 size_t count, int noblock)
704 {
705         struct sk_buff *skb;
706         struct macvlan_dev *vlan;
707         unsigned long len = total_len;
708         int err;
709         struct virtio_net_hdr vnet_hdr = { 0 };
710         int vnet_hdr_len = 0;
711         int copylen = 0;
712         bool zerocopy = false;
713
714         if (q->flags & IFF_VNET_HDR) {
715                 vnet_hdr_len = q->vnet_hdr_sz;
716
717                 err = -EINVAL;
718                 if (len < vnet_hdr_len)
719                         goto err;
720                 len -= vnet_hdr_len;
721
722                 err = memcpy_fromiovecend((void *)&vnet_hdr, iv, 0,
723                                            sizeof(vnet_hdr));
724                 if (err < 0)
725                         goto err;
726                 if ((vnet_hdr.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
727                      vnet_hdr.csum_start + vnet_hdr.csum_offset + 2 >
728                                                         vnet_hdr.hdr_len)
729                         vnet_hdr.hdr_len = vnet_hdr.csum_start +
730                                                 vnet_hdr.csum_offset + 2;
731                 err = -EINVAL;
732                 if (vnet_hdr.hdr_len > len)
733                         goto err;
734         }
735
736         err = -EINVAL;
737         if (unlikely(len < ETH_HLEN))
738                 goto err;
739
740         err = -EMSGSIZE;
741         if (unlikely(count > UIO_MAXIOV))
742                 goto err;
743
744         if (m && m->msg_control && sock_flag(&q->sk, SOCK_ZEROCOPY))
745                 zerocopy = true;
746
747         if (zerocopy) {
748                 /* Userspace may produce vectors with count greater than
749                  * MAX_SKB_FRAGS, so we need to linearize parts of the skb
750                  * to let the rest of data to be fit in the frags.
751                  */
752                 if (count > MAX_SKB_FRAGS) {
753                         copylen = iov_length(iv, count - MAX_SKB_FRAGS);
754                         if (copylen < vnet_hdr_len)
755                                 copylen = 0;
756                         else
757                                 copylen -= vnet_hdr_len;
758                 }
759                 /* There are 256 bytes to be copied in skb, so there is enough
760                  * room for skb expand head in case it is used.
761                  * The rest buffer is mapped from userspace.
762                  */
763                 if (copylen < vnet_hdr.hdr_len)
764                         copylen = vnet_hdr.hdr_len;
765                 if (!copylen)
766                         copylen = GOODCOPY_LEN;
767         } else
768                 copylen = len;
769
770         skb = macvtap_alloc_skb(&q->sk, NET_IP_ALIGN, copylen,
771                                 vnet_hdr.hdr_len, noblock, &err);
772         if (!skb)
773                 goto err;
774
775         if (zerocopy)
776                 err = zerocopy_sg_from_iovec(skb, iv, vnet_hdr_len, count);
777         else
778                 err = skb_copy_datagram_from_iovec(skb, 0, iv, vnet_hdr_len,
779                                                    len);
780         if (err)
781                 goto err_kfree;
782
783         skb_set_network_header(skb, ETH_HLEN);
784         skb_reset_mac_header(skb);
785         skb->protocol = eth_hdr(skb)->h_proto;
786
787         if (vnet_hdr_len) {
788                 err = macvtap_skb_from_vnet_hdr(skb, &vnet_hdr);
789                 if (err)
790                         goto err_kfree;
791         }
792
793         skb_probe_transport_header(skb, ETH_HLEN);
794
795         rcu_read_lock();
796         vlan = rcu_dereference(q->vlan);
797         /* copy skb_ubuf_info for callback when skb has no error */
798         if (zerocopy) {
799                 skb_shinfo(skb)->destructor_arg = m->msg_control;
800                 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
801                 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
802         }
803         if (vlan)
804                 macvlan_start_xmit(skb, vlan->dev);
805         else
806                 kfree_skb(skb);
807         rcu_read_unlock();
808
809         return total_len;
810
811 err_kfree:
812         kfree_skb(skb);
813
814 err:
815         rcu_read_lock();
816         vlan = rcu_dereference(q->vlan);
817         if (vlan)
818                 vlan->dev->stats.tx_dropped++;
819         rcu_read_unlock();
820
821         return err;
822 }
823
824 static ssize_t macvtap_aio_write(struct kiocb *iocb, const struct iovec *iv,
825                                  unsigned long count, loff_t pos)
826 {
827         struct file *file = iocb->ki_filp;
828         ssize_t result = -ENOLINK;
829         struct macvtap_queue *q = file->private_data;
830
831         result = macvtap_get_user(q, NULL, iv, iov_length(iv, count), count,
832                                   file->f_flags & O_NONBLOCK);
833         return result;
834 }
835
836 /* Put packet to the user space buffer */
837 static ssize_t macvtap_put_user(struct macvtap_queue *q,
838                                 const struct sk_buff *skb,
839                                 const struct iovec *iv, int len)
840 {
841         struct macvlan_dev *vlan;
842         int ret;
843         int vnet_hdr_len = 0;
844         int vlan_offset = 0;
845         int copied;
846
847         if (q->flags & IFF_VNET_HDR) {
848                 struct virtio_net_hdr vnet_hdr;
849                 vnet_hdr_len = q->vnet_hdr_sz;
850                 if ((len -= vnet_hdr_len) < 0)
851                         return -EINVAL;
852
853                 ret = macvtap_skb_to_vnet_hdr(skb, &vnet_hdr);
854                 if (ret)
855                         return ret;
856
857                 if (memcpy_toiovecend(iv, (void *)&vnet_hdr, 0, sizeof(vnet_hdr)))
858                         return -EFAULT;
859         }
860         copied = vnet_hdr_len;
861
862         if (!vlan_tx_tag_present(skb))
863                 len = min_t(int, skb->len, len);
864         else {
865                 int copy;
866                 struct {
867                         __be16 h_vlan_proto;
868                         __be16 h_vlan_TCI;
869                 } veth;
870                 veth.h_vlan_proto = htons(ETH_P_8021Q);
871                 veth.h_vlan_TCI = htons(vlan_tx_tag_get(skb));
872
873                 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
874                 len = min_t(int, skb->len + VLAN_HLEN, len);
875
876                 copy = min_t(int, vlan_offset, len);
877                 ret = skb_copy_datagram_const_iovec(skb, 0, iv, copied, copy);
878                 len -= copy;
879                 copied += copy;
880                 if (ret || !len)
881                         goto done;
882
883                 copy = min_t(int, sizeof(veth), len);
884                 ret = memcpy_toiovecend(iv, (void *)&veth, copied, copy);
885                 len -= copy;
886                 copied += copy;
887                 if (ret || !len)
888                         goto done;
889         }
890
891         ret = skb_copy_datagram_const_iovec(skb, vlan_offset, iv, copied, len);
892         copied += len;
893
894 done:
895         rcu_read_lock();
896         vlan = rcu_dereference(q->vlan);
897         if (vlan)
898                 macvlan_count_rx(vlan, copied - vnet_hdr_len, ret == 0, 0);
899         rcu_read_unlock();
900
901         return ret ? ret : copied;
902 }
903
904 static ssize_t macvtap_do_read(struct macvtap_queue *q, struct kiocb *iocb,
905                                const struct iovec *iv, unsigned long len,
906                                int noblock)
907 {
908         DEFINE_WAIT(wait);
909         struct sk_buff *skb;
910         ssize_t ret = 0;
911
912         while (len) {
913                 if (!noblock)
914                         prepare_to_wait(sk_sleep(&q->sk), &wait,
915                                         TASK_INTERRUPTIBLE);
916
917                 /* Read frames from the queue */
918                 skb = skb_dequeue(&q->sk.sk_receive_queue);
919                 if (!skb) {
920                         if (noblock) {
921                                 ret = -EAGAIN;
922                                 break;
923                         }
924                         if (signal_pending(current)) {
925                                 ret = -ERESTARTSYS;
926                                 break;
927                         }
928                         /* Nothing to read, let's sleep */
929                         schedule();
930                         continue;
931                 }
932                 ret = macvtap_put_user(q, skb, iv, len);
933                 kfree_skb(skb);
934                 break;
935         }
936
937         if (!noblock)
938                 finish_wait(sk_sleep(&q->sk), &wait);
939         return ret;
940 }
941
942 static ssize_t macvtap_aio_read(struct kiocb *iocb, const struct iovec *iv,
943                                 unsigned long count, loff_t pos)
944 {
945         struct file *file = iocb->ki_filp;
946         struct macvtap_queue *q = file->private_data;
947         ssize_t len, ret = 0;
948
949         len = iov_length(iv, count);
950         if (len < 0) {
951                 ret = -EINVAL;
952                 goto out;
953         }
954
955         ret = macvtap_do_read(q, iocb, iv, len, file->f_flags & O_NONBLOCK);
956         ret = min_t(ssize_t, ret, len); /* XXX copied from tun.c. Why? */
957 out:
958         return ret;
959 }
960
961 static struct macvlan_dev *macvtap_get_vlan(struct macvtap_queue *q)
962 {
963         struct macvlan_dev *vlan;
964
965         ASSERT_RTNL();
966         vlan = rtnl_dereference(q->vlan);
967         if (vlan)
968                 dev_hold(vlan->dev);
969
970         return vlan;
971 }
972
973 static void macvtap_put_vlan(struct macvlan_dev *vlan)
974 {
975         dev_put(vlan->dev);
976 }
977
978 static int macvtap_ioctl_set_queue(struct file *file, unsigned int flags)
979 {
980         struct macvtap_queue *q = file->private_data;
981         struct macvlan_dev *vlan;
982         int ret;
983
984         vlan = macvtap_get_vlan(q);
985         if (!vlan)
986                 return -EINVAL;
987
988         if (flags & IFF_ATTACH_QUEUE)
989                 ret = macvtap_enable_queue(vlan->dev, file, q);
990         else if (flags & IFF_DETACH_QUEUE)
991                 ret = macvtap_disable_queue(q);
992         else
993                 ret = -EINVAL;
994
995         macvtap_put_vlan(vlan);
996         return ret;
997 }
998
999 static int set_offload(struct macvtap_queue *q, unsigned long arg)
1000 {
1001         struct macvlan_dev *vlan;
1002         netdev_features_t features;
1003         netdev_features_t feature_mask = 0;
1004
1005         vlan = rtnl_dereference(q->vlan);
1006         if (!vlan)
1007                 return -ENOLINK;
1008
1009         features = vlan->dev->features;
1010
1011         if (arg & TUN_F_CSUM) {
1012                 feature_mask = NETIF_F_HW_CSUM;
1013
1014                 if (arg & (TUN_F_TSO4 | TUN_F_TSO6)) {
1015                         if (arg & TUN_F_TSO_ECN)
1016                                 feature_mask |= NETIF_F_TSO_ECN;
1017                         if (arg & TUN_F_TSO4)
1018                                 feature_mask |= NETIF_F_TSO;
1019                         if (arg & TUN_F_TSO6)
1020                                 feature_mask |= NETIF_F_TSO6;
1021                 }
1022
1023                 if (arg & TUN_F_UFO)
1024                         feature_mask |= NETIF_F_UFO;
1025         }
1026
1027         /* tun/tap driver inverts the usage for TSO offloads, where
1028          * setting the TSO bit means that the userspace wants to
1029          * accept TSO frames and turning it off means that user space
1030          * does not support TSO.
1031          * For macvtap, we have to invert it to mean the same thing.
1032          * When user space turns off TSO, we turn off GSO/LRO so that
1033          * user-space will not receive TSO frames.
1034          */
1035         if (feature_mask & (NETIF_F_TSO | NETIF_F_TSO6 | NETIF_F_UFO))
1036                 features |= RX_OFFLOADS;
1037         else
1038                 features &= ~RX_OFFLOADS;
1039
1040         /* tap_features are the same as features on tun/tap and
1041          * reflect user expectations.
1042          */
1043         vlan->tap_features = vlan->dev->features &
1044                             (feature_mask | ~TUN_OFFLOADS);
1045         vlan->set_features = features;
1046         netdev_update_features(vlan->dev);
1047
1048         return 0;
1049 }
1050
1051 /*
1052  * provide compatibility with generic tun/tap interface
1053  */
1054 static long macvtap_ioctl(struct file *file, unsigned int cmd,
1055                           unsigned long arg)
1056 {
1057         struct macvtap_queue *q = file->private_data;
1058         struct macvlan_dev *vlan;
1059         void __user *argp = (void __user *)arg;
1060         struct ifreq __user *ifr = argp;
1061         unsigned int __user *up = argp;
1062         unsigned int u;
1063         int __user *sp = argp;
1064         int s;
1065         int ret;
1066
1067         switch (cmd) {
1068         case TUNSETIFF:
1069                 /* ignore the name, just look at flags */
1070                 if (get_user(u, &ifr->ifr_flags))
1071                         return -EFAULT;
1072
1073                 ret = 0;
1074                 if ((u & ~(IFF_VNET_HDR | IFF_MULTI_QUEUE)) !=
1075                     (IFF_NO_PI | IFF_TAP))
1076                         ret = -EINVAL;
1077                 else
1078                         q->flags = u;
1079
1080                 return ret;
1081
1082         case TUNGETIFF:
1083                 rtnl_lock();
1084                 vlan = macvtap_get_vlan(q);
1085                 if (!vlan) {
1086                         rtnl_unlock();
1087                         return -ENOLINK;
1088                 }
1089
1090                 ret = 0;
1091                 if (copy_to_user(&ifr->ifr_name, vlan->dev->name, IFNAMSIZ) ||
1092                     put_user(q->flags, &ifr->ifr_flags))
1093                         ret = -EFAULT;
1094                 macvtap_put_vlan(vlan);
1095                 rtnl_unlock();
1096                 return ret;
1097
1098         case TUNSETQUEUE:
1099                 if (get_user(u, &ifr->ifr_flags))
1100                         return -EFAULT;
1101                 rtnl_lock();
1102                 ret = macvtap_ioctl_set_queue(file, u);
1103                 rtnl_unlock();
1104
1105         case TUNGETFEATURES:
1106                 if (put_user(IFF_TAP | IFF_NO_PI | IFF_VNET_HDR |
1107                              IFF_MULTI_QUEUE, up))
1108                         return -EFAULT;
1109                 return 0;
1110
1111         case TUNSETSNDBUF:
1112                 if (get_user(u, up))
1113                         return -EFAULT;
1114
1115                 q->sk.sk_sndbuf = u;
1116                 return 0;
1117
1118         case TUNGETVNETHDRSZ:
1119                 s = q->vnet_hdr_sz;
1120                 if (put_user(s, sp))
1121                         return -EFAULT;
1122                 return 0;
1123
1124         case TUNSETVNETHDRSZ:
1125                 if (get_user(s, sp))
1126                         return -EFAULT;
1127                 if (s < (int)sizeof(struct virtio_net_hdr))
1128                         return -EINVAL;
1129
1130                 q->vnet_hdr_sz = s;
1131                 return 0;
1132
1133         case TUNSETOFFLOAD:
1134                 /* let the user check for future flags */
1135                 if (arg & ~(TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6 |
1136                             TUN_F_TSO_ECN | TUN_F_UFO))
1137                         return -EINVAL;
1138
1139                 /* TODO: only accept frames with the features that
1140                          got enabled for forwarded frames */
1141                 if (!(q->flags & IFF_VNET_HDR))
1142                         return  -EINVAL;
1143                 rtnl_lock();
1144                 ret = set_offload(q, arg);
1145                 rtnl_unlock();
1146                 return ret;
1147
1148         default:
1149                 return -EINVAL;
1150         }
1151 }
1152
1153 #ifdef CONFIG_COMPAT
1154 static long macvtap_compat_ioctl(struct file *file, unsigned int cmd,
1155                                  unsigned long arg)
1156 {
1157         return macvtap_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
1158 }
1159 #endif
1160
1161 static const struct file_operations macvtap_fops = {
1162         .owner          = THIS_MODULE,
1163         .open           = macvtap_open,
1164         .release        = macvtap_release,
1165         .aio_read       = macvtap_aio_read,
1166         .aio_write      = macvtap_aio_write,
1167         .poll           = macvtap_poll,
1168         .llseek         = no_llseek,
1169         .unlocked_ioctl = macvtap_ioctl,
1170 #ifdef CONFIG_COMPAT
1171         .compat_ioctl   = macvtap_compat_ioctl,
1172 #endif
1173 };
1174
1175 static int macvtap_sendmsg(struct kiocb *iocb, struct socket *sock,
1176                            struct msghdr *m, size_t total_len)
1177 {
1178         struct macvtap_queue *q = container_of(sock, struct macvtap_queue, sock);
1179         return macvtap_get_user(q, m, m->msg_iov, total_len, m->msg_iovlen,
1180                             m->msg_flags & MSG_DONTWAIT);
1181 }
1182
1183 static int macvtap_recvmsg(struct kiocb *iocb, struct socket *sock,
1184                            struct msghdr *m, size_t total_len,
1185                            int flags)
1186 {
1187         struct macvtap_queue *q = container_of(sock, struct macvtap_queue, sock);
1188         int ret;
1189         if (flags & ~(MSG_DONTWAIT|MSG_TRUNC))
1190                 return -EINVAL;
1191         ret = macvtap_do_read(q, iocb, m->msg_iov, total_len,
1192                           flags & MSG_DONTWAIT);
1193         if (ret > total_len) {
1194                 m->msg_flags |= MSG_TRUNC;
1195                 ret = flags & MSG_TRUNC ? ret : total_len;
1196         }
1197         return ret;
1198 }
1199
1200 /* Ops structure to mimic raw sockets with tun */
1201 static const struct proto_ops macvtap_socket_ops = {
1202         .sendmsg = macvtap_sendmsg,
1203         .recvmsg = macvtap_recvmsg,
1204 };
1205
1206 /* Get an underlying socket object from tun file.  Returns error unless file is
1207  * attached to a device.  The returned object works like a packet socket, it
1208  * can be used for sock_sendmsg/sock_recvmsg.  The caller is responsible for
1209  * holding a reference to the file for as long as the socket is in use. */
1210 struct socket *macvtap_get_socket(struct file *file)
1211 {
1212         struct macvtap_queue *q;
1213         if (file->f_op != &macvtap_fops)
1214                 return ERR_PTR(-EINVAL);
1215         q = file->private_data;
1216         if (!q)
1217                 return ERR_PTR(-EBADFD);
1218         return &q->sock;
1219 }
1220 EXPORT_SYMBOL_GPL(macvtap_get_socket);
1221
1222 static int macvtap_device_event(struct notifier_block *unused,
1223                                 unsigned long event, void *ptr)
1224 {
1225         struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1226         struct macvlan_dev *vlan;
1227         struct device *classdev;
1228         dev_t devt;
1229         int err;
1230
1231         if (dev->rtnl_link_ops != &macvtap_link_ops)
1232                 return NOTIFY_DONE;
1233
1234         vlan = netdev_priv(dev);
1235
1236         switch (event) {
1237         case NETDEV_REGISTER:
1238                 /* Create the device node here after the network device has
1239                  * been registered but before register_netdevice has
1240                  * finished running.
1241                  */
1242                 err = macvtap_get_minor(vlan);
1243                 if (err)
1244                         return notifier_from_errno(err);
1245
1246                 devt = MKDEV(MAJOR(macvtap_major), vlan->minor);
1247                 classdev = device_create(macvtap_class, &dev->dev, devt,
1248                                          dev, "tap%d", dev->ifindex);
1249                 if (IS_ERR(classdev)) {
1250                         macvtap_free_minor(vlan);
1251                         return notifier_from_errno(PTR_ERR(classdev));
1252                 }
1253                 break;
1254         case NETDEV_UNREGISTER:
1255                 devt = MKDEV(MAJOR(macvtap_major), vlan->minor);
1256                 device_destroy(macvtap_class, devt);
1257                 macvtap_free_minor(vlan);
1258                 break;
1259         }
1260
1261         return NOTIFY_DONE;
1262 }
1263
1264 static struct notifier_block macvtap_notifier_block __read_mostly = {
1265         .notifier_call  = macvtap_device_event,
1266 };
1267
1268 static int macvtap_init(void)
1269 {
1270         int err;
1271
1272         err = alloc_chrdev_region(&macvtap_major, 0,
1273                                 MACVTAP_NUM_DEVS, "macvtap");
1274         if (err)
1275                 goto out1;
1276
1277         cdev_init(&macvtap_cdev, &macvtap_fops);
1278         err = cdev_add(&macvtap_cdev, macvtap_major, MACVTAP_NUM_DEVS);
1279         if (err)
1280                 goto out2;
1281
1282         macvtap_class = class_create(THIS_MODULE, "macvtap");
1283         if (IS_ERR(macvtap_class)) {
1284                 err = PTR_ERR(macvtap_class);
1285                 goto out3;
1286         }
1287
1288         err = register_netdevice_notifier(&macvtap_notifier_block);
1289         if (err)
1290                 goto out4;
1291
1292         err = macvlan_link_register(&macvtap_link_ops);
1293         if (err)
1294                 goto out5;
1295
1296         return 0;
1297
1298 out5:
1299         unregister_netdevice_notifier(&macvtap_notifier_block);
1300 out4:
1301         class_unregister(macvtap_class);
1302 out3:
1303         cdev_del(&macvtap_cdev);
1304 out2:
1305         unregister_chrdev_region(macvtap_major, MACVTAP_NUM_DEVS);
1306 out1:
1307         return err;
1308 }
1309 module_init(macvtap_init);
1310
1311 static void macvtap_exit(void)
1312 {
1313         rtnl_link_unregister(&macvtap_link_ops);
1314         unregister_netdevice_notifier(&macvtap_notifier_block);
1315         class_unregister(macvtap_class);
1316         cdev_del(&macvtap_cdev);
1317         unregister_chrdev_region(macvtap_major, MACVTAP_NUM_DEVS);
1318 }
1319 module_exit(macvtap_exit);
1320
1321 MODULE_ALIAS_RTNL_LINK("macvtap");
1322 MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
1323 MODULE_LICENSE("GPL");