vrf: drop unnecessary dev refcnt changes
[firefly-linux-kernel-4.4.55.git] / drivers / net / vrf.c
1 /*
2  * vrf.c: device driver to encapsulate a VRF space
3  *
4  * Copyright (c) 2015 Cumulus Networks. All rights reserved.
5  * Copyright (c) 2015 Shrijeet Mukherjee <shm@cumulusnetworks.com>
6  * Copyright (c) 2015 David Ahern <dsa@cumulusnetworks.com>
7  *
8  * Based on dummy, team and ipvlan drivers
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  */
15
16 #include <linux/module.h>
17 #include <linux/kernel.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/ip.h>
21 #include <linux/init.h>
22 #include <linux/moduleparam.h>
23 #include <linux/netfilter.h>
24 #include <linux/rtnetlink.h>
25 #include <net/rtnetlink.h>
26 #include <linux/u64_stats_sync.h>
27 #include <linux/hashtable.h>
28
29 #include <linux/inetdevice.h>
30 #include <net/ip.h>
31 #include <net/ip_fib.h>
32 #include <net/ip6_route.h>
33 #include <net/rtnetlink.h>
34 #include <net/route.h>
35 #include <net/addrconf.h>
36 #include <net/vrf.h>
37
38 #define DRV_NAME        "vrf"
39 #define DRV_VERSION     "1.0"
40
41 #define vrf_is_slave(dev)   ((dev)->flags & IFF_SLAVE)
42
43 #define vrf_master_get_rcu(dev) \
44         ((struct net_device *)rcu_dereference(dev->rx_handler_data))
45
46 struct pcpu_dstats {
47         u64                     tx_pkts;
48         u64                     tx_bytes;
49         u64                     tx_drps;
50         u64                     rx_pkts;
51         u64                     rx_bytes;
52         struct u64_stats_sync   syncp;
53 };
54
55 static struct dst_entry *vrf_ip_check(struct dst_entry *dst, u32 cookie)
56 {
57         return dst;
58 }
59
60 static int vrf_ip_local_out(struct sk_buff *skb)
61 {
62         return ip_local_out(skb);
63 }
64
65 static unsigned int vrf_v4_mtu(const struct dst_entry *dst)
66 {
67         /* TO-DO: return max ethernet size? */
68         return dst->dev->mtu;
69 }
70
71 static void vrf_dst_destroy(struct dst_entry *dst)
72 {
73         /* our dst lives forever - or until the device is closed */
74 }
75
76 static unsigned int vrf_default_advmss(const struct dst_entry *dst)
77 {
78         return 65535 - 40;
79 }
80
81 static struct dst_ops vrf_dst_ops = {
82         .family         = AF_INET,
83         .local_out      = vrf_ip_local_out,
84         .check          = vrf_ip_check,
85         .mtu            = vrf_v4_mtu,
86         .destroy        = vrf_dst_destroy,
87         .default_advmss = vrf_default_advmss,
88 };
89
90 static bool is_ip_rx_frame(struct sk_buff *skb)
91 {
92         switch (skb->protocol) {
93         case htons(ETH_P_IP):
94         case htons(ETH_P_IPV6):
95                 return true;
96         }
97         return false;
98 }
99
100 /* note: already called with rcu_read_lock */
101 static rx_handler_result_t vrf_handle_frame(struct sk_buff **pskb)
102 {
103         struct sk_buff *skb = *pskb;
104
105         if (is_ip_rx_frame(skb)) {
106                 struct net_device *dev = vrf_master_get_rcu(skb->dev);
107                 struct pcpu_dstats *dstats = this_cpu_ptr(dev->dstats);
108
109                 u64_stats_update_begin(&dstats->syncp);
110                 dstats->rx_pkts++;
111                 dstats->rx_bytes += skb->len;
112                 u64_stats_update_end(&dstats->syncp);
113
114                 skb->dev = dev;
115
116                 return RX_HANDLER_ANOTHER;
117         }
118         return RX_HANDLER_PASS;
119 }
120
121 static struct rtnl_link_stats64 *vrf_get_stats64(struct net_device *dev,
122                                                  struct rtnl_link_stats64 *stats)
123 {
124         int i;
125
126         for_each_possible_cpu(i) {
127                 const struct pcpu_dstats *dstats;
128                 u64 tbytes, tpkts, tdrops, rbytes, rpkts;
129                 unsigned int start;
130
131                 dstats = per_cpu_ptr(dev->dstats, i);
132                 do {
133                         start = u64_stats_fetch_begin_irq(&dstats->syncp);
134                         tbytes = dstats->tx_bytes;
135                         tpkts = dstats->tx_pkts;
136                         tdrops = dstats->tx_drps;
137                         rbytes = dstats->rx_bytes;
138                         rpkts = dstats->rx_pkts;
139                 } while (u64_stats_fetch_retry_irq(&dstats->syncp, start));
140                 stats->tx_bytes += tbytes;
141                 stats->tx_packets += tpkts;
142                 stats->tx_dropped += tdrops;
143                 stats->rx_bytes += rbytes;
144                 stats->rx_packets += rpkts;
145         }
146         return stats;
147 }
148
149 static netdev_tx_t vrf_process_v6_outbound(struct sk_buff *skb,
150                                            struct net_device *dev)
151 {
152         return 0;
153 }
154
155 static int vrf_send_v4_prep(struct sk_buff *skb, struct flowi4 *fl4,
156                             struct net_device *vrf_dev)
157 {
158         struct rtable *rt;
159         int err = 1;
160
161         rt = ip_route_output_flow(dev_net(vrf_dev), fl4, NULL);
162         if (IS_ERR(rt))
163                 goto out;
164
165         /* TO-DO: what about broadcast ? */
166         if (rt->rt_type != RTN_UNICAST && rt->rt_type != RTN_LOCAL) {
167                 ip_rt_put(rt);
168                 goto out;
169         }
170
171         skb_dst_drop(skb);
172         skb_dst_set(skb, &rt->dst);
173         err = 0;
174 out:
175         return err;
176 }
177
178 static netdev_tx_t vrf_process_v4_outbound(struct sk_buff *skb,
179                                            struct net_device *vrf_dev)
180 {
181         struct iphdr *ip4h = ip_hdr(skb);
182         int ret = NET_XMIT_DROP;
183         struct flowi4 fl4 = {
184                 /* needed to match OIF rule */
185                 .flowi4_oif = vrf_dev->ifindex,
186                 .flowi4_iif = LOOPBACK_IFINDEX,
187                 .flowi4_tos = RT_TOS(ip4h->tos),
188                 .flowi4_flags = FLOWI_FLAG_ANYSRC | FLOWI_FLAG_VRFSRC,
189                 .daddr = ip4h->daddr,
190         };
191
192         if (vrf_send_v4_prep(skb, &fl4, vrf_dev))
193                 goto err;
194
195         if (!ip4h->saddr) {
196                 ip4h->saddr = inet_select_addr(skb_dst(skb)->dev, 0,
197                                                RT_SCOPE_LINK);
198         }
199
200         ret = ip_local_out(skb);
201         if (unlikely(net_xmit_eval(ret)))
202                 vrf_dev->stats.tx_errors++;
203         else
204                 ret = NET_XMIT_SUCCESS;
205
206 out:
207         return ret;
208 err:
209         vrf_dev->stats.tx_errors++;
210         kfree_skb(skb);
211         goto out;
212 }
213
214 static netdev_tx_t is_ip_tx_frame(struct sk_buff *skb, struct net_device *dev)
215 {
216         switch (skb->protocol) {
217         case htons(ETH_P_IP):
218                 return vrf_process_v4_outbound(skb, dev);
219         case htons(ETH_P_IPV6):
220                 return vrf_process_v6_outbound(skb, dev);
221         default:
222                 return NET_XMIT_DROP;
223         }
224 }
225
226 static netdev_tx_t vrf_xmit(struct sk_buff *skb, struct net_device *dev)
227 {
228         netdev_tx_t ret = is_ip_tx_frame(skb, dev);
229
230         if (likely(ret == NET_XMIT_SUCCESS || ret == NET_XMIT_CN)) {
231                 struct pcpu_dstats *dstats = this_cpu_ptr(dev->dstats);
232
233                 u64_stats_update_begin(&dstats->syncp);
234                 dstats->tx_pkts++;
235                 dstats->tx_bytes += skb->len;
236                 u64_stats_update_end(&dstats->syncp);
237         } else {
238                 this_cpu_inc(dev->dstats->tx_drps);
239         }
240
241         return ret;
242 }
243
244 static netdev_tx_t vrf_finish(struct sock *sk, struct sk_buff *skb)
245 {
246         return dev_queue_xmit(skb);
247 }
248
249 static int vrf_output(struct sock *sk, struct sk_buff *skb)
250 {
251         struct net_device *dev = skb_dst(skb)->dev;
252
253         IP_UPD_PO_STATS(dev_net(dev), IPSTATS_MIB_OUT, skb->len);
254
255         skb->dev = dev;
256         skb->protocol = htons(ETH_P_IP);
257
258         return NF_HOOK_COND(NFPROTO_IPV4, NF_INET_POST_ROUTING, sk, skb,
259                             NULL, dev,
260                             vrf_finish,
261                             !(IPCB(skb)->flags & IPSKB_REROUTED));
262 }
263
264 static void vrf_rtable_destroy(struct net_vrf *vrf)
265 {
266         struct dst_entry *dst = (struct dst_entry *)vrf->rth;
267
268         if (dst)
269                 dst_destroy(dst);
270         vrf->rth = NULL;
271 }
272
273 static struct rtable *vrf_rtable_create(struct net_device *dev)
274 {
275         struct rtable *rth;
276
277         rth = dst_alloc(&vrf_dst_ops, dev, 2,
278                         DST_OBSOLETE_NONE,
279                         (DST_HOST | DST_NOPOLICY | DST_NOXFRM));
280         if (rth) {
281                 rth->dst.output = vrf_output;
282                 rth->rt_genid   = rt_genid_ipv4(dev_net(dev));
283                 rth->rt_flags   = 0;
284                 rth->rt_type    = RTN_UNICAST;
285                 rth->rt_is_input = 0;
286                 rth->rt_iif     = 0;
287                 rth->rt_pmtu    = 0;
288                 rth->rt_gateway = 0;
289                 rth->rt_uses_gateway = 0;
290                 INIT_LIST_HEAD(&rth->rt_uncached);
291                 rth->rt_uncached_list = NULL;
292                 rth->rt_lwtstate = NULL;
293         }
294
295         return rth;
296 }
297
298 /**************************** device handling ********************/
299
300 /* cycle interface to flush neighbor cache and move routes across tables */
301 static void cycle_netdev(struct net_device *dev)
302 {
303         unsigned int flags = dev->flags;
304         int ret;
305
306         if (!netif_running(dev))
307                 return;
308
309         ret = dev_change_flags(dev, flags & ~IFF_UP);
310         if (ret >= 0)
311                 ret = dev_change_flags(dev, flags);
312
313         if (ret < 0) {
314                 netdev_err(dev,
315                            "Failed to cycle device %s; route tables might be wrong!\n",
316                            dev->name);
317         }
318 }
319
320 static struct slave *__vrf_find_slave_dev(struct slave_queue *queue,
321                                           struct net_device *dev)
322 {
323         struct list_head *head = &queue->all_slaves;
324         struct slave *slave;
325
326         list_for_each_entry(slave, head, list) {
327                 if (slave->dev == dev)
328                         return slave;
329         }
330
331         return NULL;
332 }
333
334 /* inverse of __vrf_insert_slave */
335 static void __vrf_remove_slave(struct slave_queue *queue, struct slave *slave)
336 {
337         list_del(&slave->list);
338         queue->num_slaves--;
339 }
340
341 static void __vrf_insert_slave(struct slave_queue *queue, struct slave *slave)
342 {
343         list_add(&slave->list, &queue->all_slaves);
344         queue->num_slaves++;
345 }
346
347 static int do_vrf_add_slave(struct net_device *dev, struct net_device *port_dev)
348 {
349         struct net_vrf_dev *vrf_ptr = kmalloc(sizeof(*vrf_ptr), GFP_KERNEL);
350         struct slave *slave = kzalloc(sizeof(*slave), GFP_KERNEL);
351         struct slave *duplicate_slave;
352         struct net_vrf *vrf = netdev_priv(dev);
353         struct slave_queue *queue = &vrf->queue;
354         int ret = -ENOMEM;
355
356         if (!slave || !vrf_ptr)
357                 goto out_fail;
358
359         slave->dev = port_dev;
360
361         vrf_ptr->ifindex = dev->ifindex;
362         vrf_ptr->tb_id = vrf->tb_id;
363
364         duplicate_slave = __vrf_find_slave_dev(queue, port_dev);
365         if (duplicate_slave) {
366                 ret = -EBUSY;
367                 goto out_fail;
368         }
369
370         __vrf_insert_slave(queue, slave);
371
372         /* register the packet handler for slave ports */
373         ret = netdev_rx_handler_register(port_dev, vrf_handle_frame, dev);
374         if (ret) {
375                 netdev_err(port_dev,
376                            "Device %s failed to register rx_handler\n",
377                            port_dev->name);
378                 goto out_remove;
379         }
380
381         ret = netdev_master_upper_dev_link(port_dev, dev);
382         if (ret < 0)
383                 goto out_unregister;
384
385         port_dev->flags |= IFF_SLAVE;
386
387         rcu_assign_pointer(port_dev->vrf_ptr, vrf_ptr);
388         cycle_netdev(port_dev);
389
390         return 0;
391
392 out_unregister:
393         netdev_rx_handler_unregister(port_dev);
394 out_remove:
395         __vrf_remove_slave(queue, slave);
396 out_fail:
397         kfree(vrf_ptr);
398         kfree(slave);
399         return ret;
400 }
401
402 static int vrf_add_slave(struct net_device *dev, struct net_device *port_dev)
403 {
404         if (!netif_is_vrf(dev) || netif_is_vrf(port_dev) ||
405             vrf_is_slave(port_dev))
406                 return -EINVAL;
407
408         return do_vrf_add_slave(dev, port_dev);
409 }
410
411 /* inverse of do_vrf_add_slave */
412 static int do_vrf_del_slave(struct net_device *dev, struct net_device *port_dev)
413 {
414         struct net_vrf_dev *vrf_ptr = rtnl_dereference(port_dev->vrf_ptr);
415         struct net_vrf *vrf = netdev_priv(dev);
416         struct slave_queue *queue = &vrf->queue;
417         struct slave *slave;
418
419         RCU_INIT_POINTER(port_dev->vrf_ptr, NULL);
420
421         netdev_upper_dev_unlink(port_dev, dev);
422         port_dev->flags &= ~IFF_SLAVE;
423
424         netdev_rx_handler_unregister(port_dev);
425
426         /* after netdev_rx_handler_unregister for synchronize_rcu */
427         kfree(vrf_ptr);
428
429         cycle_netdev(port_dev);
430
431         slave = __vrf_find_slave_dev(queue, port_dev);
432         if (slave)
433                 __vrf_remove_slave(queue, slave);
434
435         kfree(slave);
436
437         return 0;
438 }
439
440 static int vrf_del_slave(struct net_device *dev, struct net_device *port_dev)
441 {
442         if (!netif_is_vrf(dev))
443                 return -EINVAL;
444
445         return do_vrf_del_slave(dev, port_dev);
446 }
447
448 static void vrf_dev_uninit(struct net_device *dev)
449 {
450         struct net_vrf *vrf = netdev_priv(dev);
451         struct slave_queue *queue = &vrf->queue;
452         struct list_head *head = &queue->all_slaves;
453         struct slave *slave, *next;
454
455         vrf_rtable_destroy(vrf);
456
457         list_for_each_entry_safe(slave, next, head, list)
458                 vrf_del_slave(dev, slave->dev);
459
460         if (dev->dstats)
461                 free_percpu(dev->dstats);
462         dev->dstats = NULL;
463 }
464
465 static int vrf_dev_init(struct net_device *dev)
466 {
467         struct net_vrf *vrf = netdev_priv(dev);
468
469         INIT_LIST_HEAD(&vrf->queue.all_slaves);
470
471         dev->dstats = netdev_alloc_pcpu_stats(struct pcpu_dstats);
472         if (!dev->dstats)
473                 goto out_nomem;
474
475         /* create the default dst which points back to us */
476         vrf->rth = vrf_rtable_create(dev);
477         if (!vrf->rth)
478                 goto out_stats;
479
480         dev->flags = IFF_MASTER | IFF_NOARP;
481
482         return 0;
483
484 out_stats:
485         free_percpu(dev->dstats);
486         dev->dstats = NULL;
487 out_nomem:
488         return -ENOMEM;
489 }
490
491 static const struct net_device_ops vrf_netdev_ops = {
492         .ndo_init               = vrf_dev_init,
493         .ndo_uninit             = vrf_dev_uninit,
494         .ndo_start_xmit         = vrf_xmit,
495         .ndo_get_stats64        = vrf_get_stats64,
496         .ndo_add_slave          = vrf_add_slave,
497         .ndo_del_slave          = vrf_del_slave,
498 };
499
500 static void vrf_get_drvinfo(struct net_device *dev,
501                             struct ethtool_drvinfo *info)
502 {
503         strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
504         strlcpy(info->version, DRV_VERSION, sizeof(info->version));
505 }
506
507 static const struct ethtool_ops vrf_ethtool_ops = {
508         .get_drvinfo    = vrf_get_drvinfo,
509 };
510
511 static void vrf_setup(struct net_device *dev)
512 {
513         ether_setup(dev);
514
515         /* Initialize the device structure. */
516         dev->netdev_ops = &vrf_netdev_ops;
517         dev->ethtool_ops = &vrf_ethtool_ops;
518         dev->destructor = free_netdev;
519
520         /* Fill in device structure with ethernet-generic values. */
521         eth_hw_addr_random(dev);
522
523         /* don't acquire vrf device's netif_tx_lock when transmitting */
524         dev->features |= NETIF_F_LLTX;
525
526         /* don't allow vrf devices to change network namespaces. */
527         dev->features |= NETIF_F_NETNS_LOCAL;
528 }
529
530 static int vrf_validate(struct nlattr *tb[], struct nlattr *data[])
531 {
532         if (tb[IFLA_ADDRESS]) {
533                 if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
534                         return -EINVAL;
535                 if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
536                         return -EADDRNOTAVAIL;
537         }
538         return 0;
539 }
540
541 static void vrf_dellink(struct net_device *dev, struct list_head *head)
542 {
543         struct net_vrf_dev *vrf_ptr = rtnl_dereference(dev->vrf_ptr);
544
545         RCU_INIT_POINTER(dev->vrf_ptr, NULL);
546         kfree_rcu(vrf_ptr, rcu);
547         unregister_netdevice_queue(dev, head);
548 }
549
550 static int vrf_newlink(struct net *src_net, struct net_device *dev,
551                        struct nlattr *tb[], struct nlattr *data[])
552 {
553         struct net_vrf *vrf = netdev_priv(dev);
554         struct net_vrf_dev *vrf_ptr;
555         int err;
556
557         if (!data || !data[IFLA_VRF_TABLE])
558                 return -EINVAL;
559
560         vrf->tb_id = nla_get_u32(data[IFLA_VRF_TABLE]);
561
562         dev->priv_flags |= IFF_VRF_MASTER;
563
564         err = -ENOMEM;
565         vrf_ptr = kmalloc(sizeof(*dev->vrf_ptr), GFP_KERNEL);
566         if (!vrf_ptr)
567                 goto out_fail;
568
569         vrf_ptr->ifindex = dev->ifindex;
570         vrf_ptr->tb_id = vrf->tb_id;
571
572         err = register_netdevice(dev);
573         if (err < 0)
574                 goto out_fail;
575
576         rcu_assign_pointer(dev->vrf_ptr, vrf_ptr);
577
578         return 0;
579
580 out_fail:
581         kfree(vrf_ptr);
582         free_netdev(dev);
583         return err;
584 }
585
586 static size_t vrf_nl_getsize(const struct net_device *dev)
587 {
588         return nla_total_size(sizeof(u32));  /* IFLA_VRF_TABLE */
589 }
590
591 static int vrf_fillinfo(struct sk_buff *skb,
592                         const struct net_device *dev)
593 {
594         struct net_vrf *vrf = netdev_priv(dev);
595
596         return nla_put_u32(skb, IFLA_VRF_TABLE, vrf->tb_id);
597 }
598
599 static const struct nla_policy vrf_nl_policy[IFLA_VRF_MAX + 1] = {
600         [IFLA_VRF_TABLE] = { .type = NLA_U32 },
601 };
602
603 static struct rtnl_link_ops vrf_link_ops __read_mostly = {
604         .kind           = DRV_NAME,
605         .priv_size      = sizeof(struct net_vrf),
606
607         .get_size       = vrf_nl_getsize,
608         .policy         = vrf_nl_policy,
609         .validate       = vrf_validate,
610         .fill_info      = vrf_fillinfo,
611
612         .newlink        = vrf_newlink,
613         .dellink        = vrf_dellink,
614         .setup          = vrf_setup,
615         .maxtype        = IFLA_VRF_MAX,
616 };
617
618 static int vrf_device_event(struct notifier_block *unused,
619                             unsigned long event, void *ptr)
620 {
621         struct net_device *dev = netdev_notifier_info_to_dev(ptr);
622
623         /* only care about unregister events to drop slave references */
624         if (event == NETDEV_UNREGISTER) {
625                 struct net_vrf_dev *vrf_ptr = rtnl_dereference(dev->vrf_ptr);
626                 struct net_device *vrf_dev;
627
628                 if (!vrf_ptr || netif_is_vrf(dev))
629                         goto out;
630
631                 vrf_dev = __dev_get_by_index(dev_net(dev), vrf_ptr->ifindex);
632                 if (vrf_dev)
633                         vrf_del_slave(vrf_dev, dev);
634         }
635 out:
636         return NOTIFY_DONE;
637 }
638
639 static struct notifier_block vrf_notifier_block __read_mostly = {
640         .notifier_call = vrf_device_event,
641 };
642
643 static int __init vrf_init_module(void)
644 {
645         int rc;
646
647         vrf_dst_ops.kmem_cachep =
648                 kmem_cache_create("vrf_ip_dst_cache",
649                                   sizeof(struct rtable), 0,
650                                   SLAB_HWCACHE_ALIGN | SLAB_PANIC,
651                                   NULL);
652
653         if (!vrf_dst_ops.kmem_cachep)
654                 return -ENOMEM;
655
656         register_netdevice_notifier(&vrf_notifier_block);
657
658         rc = rtnl_link_register(&vrf_link_ops);
659         if (rc < 0)
660                 goto error;
661
662         return 0;
663
664 error:
665         unregister_netdevice_notifier(&vrf_notifier_block);
666         kmem_cache_destroy(vrf_dst_ops.kmem_cachep);
667         return rc;
668 }
669
670 static void __exit vrf_cleanup_module(void)
671 {
672         rtnl_link_unregister(&vrf_link_ops);
673         unregister_netdevice_notifier(&vrf_notifier_block);
674         kmem_cache_destroy(vrf_dst_ops.kmem_cachep);
675 }
676
677 module_init(vrf_init_module);
678 module_exit(vrf_cleanup_module);
679 MODULE_AUTHOR("Shrijeet Mukherjee, David Ahern");
680 MODULE_DESCRIPTION("Device driver to instantiate VRF domains");
681 MODULE_LICENSE("GPL");
682 MODULE_ALIAS_RTNL_LINK(DRV_NAME);
683 MODULE_VERSION(DRV_VERSION);