2 * Linux NET3: IP/IP protocol decoder.
8 * Alan Cox : Merged and made usable non modular (its so tiny its silly as
9 * a module taking up 2 pages).
10 * Alan Cox : Fixed bug with 1.3.18 and IPIP not working (now needs to set skb->h.iph)
11 * to keep ip_forward happy.
12 * Alan Cox : More fixes for 1.3.21, and firewall fix. Maybe this will work soon 8).
13 * Kai Schulte : Fixed #defines for IP_FIREWALL->FIREWALL
14 * David Woodhouse : Perform some basic ICMP handling.
15 * IPIP Routing without decapsulation.
16 * Carlos Picoto : GRE over IP support
17 * Alexey Kuznetsov: Reworked. Really, now it is truncated version of ipv4/ip_gre.c.
18 * I do not want to merge them together.
20 * This program is free software; you can redistribute it and/or
21 * modify it under the terms of the GNU General Public License
22 * as published by the Free Software Foundation; either version
23 * 2 of the License, or (at your option) any later version.
27 /* tunnel.c: an IP tunnel driver
29 The purpose of this driver is to provide an IP tunnel through
30 which you can tunnel network traffic transparently across subnets.
32 This was written by looking at Nick Holloway's dummy driver
33 Thanks for the great code!
38 Cleaned up the code a little and added some pre-1.3.0 tweaks.
39 dev->hard_header/hard_header_len changed to use no headers.
40 Comments/bracketing tweaked.
41 Made the tunnels use dev->name not tunnel: when error reporting.
47 Changed to tunnel to destination gateway in addition to the
48 tunnel's pointopoint address
49 Almost completely rewritten
50 Note: There is currently no firewall or ICMP handling done.
56 /* Things I wish I had known when writing the tunnel driver:
58 When the tunnel_xmit() function is called, the skb contains the
59 packet to be sent (plus a great deal of extra info), and dev
60 contains the tunnel device that _we_ are.
62 When we are passed a packet, we are expected to fill in the
63 source address with our source IP address.
65 What is the proper way to allocate, copy and free a buffer?
66 After you allocate it, it is a "0 length" chunk of memory
67 starting at zero. If you want to add headers to the buffer
68 later, you'll have to call "skb_reserve(skb, amount)" with
69 the amount of memory you want reserved. Then, you call
70 "skb_put(skb, amount)" with the amount of space you want in
71 the buffer. skb_put() returns a pointer to the top (#0) of
72 that buffer. skb->len is set to the amount of space you have
73 "allocated" with skb_put(). You can then write up to skb->len
74 bytes to that buffer. If you need more, you can call skb_put()
75 again with the additional amount of space you need. You can
76 find out how much more space you can allocate by calling
78 Now, to add header space, call "skb_push(skb, header_len)".
79 This creates space at the beginning of the buffer and returns
80 a pointer to this new space. If later you need to strip a
81 header from a buffer, call "skb_pull(skb, header_len)".
82 skb_headroom() will return how much space is left at the top
83 of the buffer (before the main data). Remember, this headroom
84 space must be reserved before the skb_put() function is called.
88 This version of net/ipv4/ipip.c is cloned of net/ipv4/ip_gre.c
90 For comments look at net/ipv4/ip_gre.c --ANK
94 #include <linux/capability.h>
95 #include <linux/module.h>
96 #include <linux/types.h>
97 #include <linux/kernel.h>
98 #include <linux/slab.h>
99 #include <asm/uaccess.h>
100 #include <linux/skbuff.h>
101 #include <linux/netdevice.h>
102 #include <linux/in.h>
103 #include <linux/tcp.h>
104 #include <linux/udp.h>
105 #include <linux/if_arp.h>
106 #include <linux/mroute.h>
107 #include <linux/init.h>
108 #include <linux/netfilter_ipv4.h>
109 #include <linux/if_ether.h>
111 #include <net/sock.h>
113 #include <net/icmp.h>
114 #include <net/ipip.h>
115 #include <net/inet_ecn.h>
116 #include <net/xfrm.h>
117 #include <net/net_namespace.h>
118 #include <net/netns/generic.h>
121 #define HASH(addr) (((__force u32)addr^((__force u32)addr>>4))&0xF)
123 static int ipip_net_id __read_mostly;
125 struct ip_tunnel __rcu *tunnels_r_l[HASH_SIZE];
126 struct ip_tunnel __rcu *tunnels_r[HASH_SIZE];
127 struct ip_tunnel __rcu *tunnels_l[HASH_SIZE];
128 struct ip_tunnel __rcu *tunnels_wc[1];
129 struct ip_tunnel __rcu **tunnels[4];
131 struct net_device *fb_tunnel_dev;
134 static int ipip_tunnel_init(struct net_device *dev);
135 static void ipip_tunnel_setup(struct net_device *dev);
136 static void ipip_dev_free(struct net_device *dev);
139 * Locking : hash tables are protected by RCU and RTNL
142 #define for_each_ip_tunnel_rcu(start) \
143 for (t = rcu_dereference(start); t; t = rcu_dereference(t->next))
145 /* often modified stats are per cpu, other are shared (netdev->stats) */
151 struct u64_stats_sync syncp;
154 static struct rtnl_link_stats64 *ipip_get_stats64(struct net_device *dev,
155 struct rtnl_link_stats64 *tot)
159 for_each_possible_cpu(i) {
160 const struct pcpu_tstats *tstats = per_cpu_ptr(dev->tstats, i);
161 u64 rx_packets, rx_bytes, tx_packets, tx_bytes;
165 start = u64_stats_fetch_begin_bh(&tstats->syncp);
166 rx_packets = tstats->rx_packets;
167 tx_packets = tstats->tx_packets;
168 rx_bytes = tstats->rx_bytes;
169 tx_bytes = tstats->tx_bytes;
170 } while (u64_stats_fetch_retry_bh(&tstats->syncp, start));
172 tot->rx_packets += rx_packets;
173 tot->tx_packets += tx_packets;
174 tot->rx_bytes += rx_bytes;
175 tot->tx_bytes += tx_bytes;
178 tot->tx_fifo_errors = dev->stats.tx_fifo_errors;
179 tot->tx_carrier_errors = dev->stats.tx_carrier_errors;
180 tot->tx_dropped = dev->stats.tx_dropped;
181 tot->tx_aborted_errors = dev->stats.tx_aborted_errors;
182 tot->tx_errors = dev->stats.tx_errors;
183 tot->collisions = dev->stats.collisions;
188 static struct ip_tunnel *ipip_tunnel_lookup(struct net *net,
189 __be32 remote, __be32 local)
191 unsigned int h0 = HASH(remote);
192 unsigned int h1 = HASH(local);
194 struct ipip_net *ipn = net_generic(net, ipip_net_id);
196 for_each_ip_tunnel_rcu(ipn->tunnels_r_l[h0 ^ h1])
197 if (local == t->parms.iph.saddr &&
198 remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
201 for_each_ip_tunnel_rcu(ipn->tunnels_r[h0])
202 if (remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
205 for_each_ip_tunnel_rcu(ipn->tunnels_l[h1])
206 if (local == t->parms.iph.saddr && (t->dev->flags&IFF_UP))
209 t = rcu_dereference(ipn->tunnels_wc[0]);
210 if (t && (t->dev->flags&IFF_UP))
215 static struct ip_tunnel __rcu **__ipip_bucket(struct ipip_net *ipn,
216 struct ip_tunnel_parm *parms)
218 __be32 remote = parms->iph.daddr;
219 __be32 local = parms->iph.saddr;
231 return &ipn->tunnels[prio][h];
234 static inline struct ip_tunnel __rcu **ipip_bucket(struct ipip_net *ipn,
237 return __ipip_bucket(ipn, &t->parms);
240 static void ipip_tunnel_unlink(struct ipip_net *ipn, struct ip_tunnel *t)
242 struct ip_tunnel __rcu **tp;
243 struct ip_tunnel *iter;
245 for (tp = ipip_bucket(ipn, t);
246 (iter = rtnl_dereference(*tp)) != NULL;
249 rcu_assign_pointer(*tp, t->next);
255 static void ipip_tunnel_link(struct ipip_net *ipn, struct ip_tunnel *t)
257 struct ip_tunnel __rcu **tp = ipip_bucket(ipn, t);
259 rcu_assign_pointer(t->next, rtnl_dereference(*tp));
260 rcu_assign_pointer(*tp, t);
263 static struct ip_tunnel *ipip_tunnel_locate(struct net *net,
264 struct ip_tunnel_parm *parms, int create)
266 __be32 remote = parms->iph.daddr;
267 __be32 local = parms->iph.saddr;
268 struct ip_tunnel *t, *nt;
269 struct ip_tunnel __rcu **tp;
270 struct net_device *dev;
272 struct ipip_net *ipn = net_generic(net, ipip_net_id);
274 for (tp = __ipip_bucket(ipn, parms);
275 (t = rtnl_dereference(*tp)) != NULL;
277 if (local == t->parms.iph.saddr && remote == t->parms.iph.daddr)
284 strlcpy(name, parms->name, IFNAMSIZ);
286 strcpy(name, "tunl%d");
288 dev = alloc_netdev(sizeof(*t), name, ipip_tunnel_setup);
292 dev_net_set(dev, net);
294 nt = netdev_priv(dev);
297 if (ipip_tunnel_init(dev) < 0)
300 if (register_netdevice(dev) < 0)
303 strcpy(nt->parms.name, dev->name);
306 ipip_tunnel_link(ipn, nt);
314 /* called with RTNL */
315 static void ipip_tunnel_uninit(struct net_device *dev)
317 struct net *net = dev_net(dev);
318 struct ipip_net *ipn = net_generic(net, ipip_net_id);
320 if (dev == ipn->fb_tunnel_dev)
321 RCU_INIT_POINTER(ipn->tunnels_wc[0], NULL);
323 ipip_tunnel_unlink(ipn, netdev_priv(dev));
327 static int ipip_err(struct sk_buff *skb, u32 info)
330 /* All the routers (except for Linux) return only
331 8 bytes of packet payload. It means, that precise relaying of
332 ICMP in the real Internet is absolutely infeasible.
334 const struct iphdr *iph = (const struct iphdr *)skb->data;
335 const int type = icmp_hdr(skb)->type;
336 const int code = icmp_hdr(skb)->code;
342 case ICMP_PARAMETERPROB:
345 case ICMP_DEST_UNREACH:
348 case ICMP_PORT_UNREACH:
349 /* Impossible event. */
351 case ICMP_FRAG_NEEDED:
352 /* Soft state for pmtu is maintained by IP core. */
355 /* All others are translated to HOST_UNREACH.
356 rfc2003 contains "deep thoughts" about NET_UNREACH,
357 I believe they are just ether pollution. --ANK
362 case ICMP_TIME_EXCEEDED:
363 if (code != ICMP_EXC_TTL)
371 t = ipip_tunnel_lookup(dev_net(skb->dev), iph->daddr, iph->saddr);
372 if (t == NULL || t->parms.iph.daddr == 0)
376 if (t->parms.iph.ttl == 0 && type == ICMP_TIME_EXCEEDED)
379 if (time_before(jiffies, t->err_time + IPTUNNEL_ERR_TIMEO))
383 t->err_time = jiffies;
389 static inline void ipip_ecn_decapsulate(const struct iphdr *outer_iph,
392 struct iphdr *inner_iph = ip_hdr(skb);
394 if (INET_ECN_is_ce(outer_iph->tos))
395 IP_ECN_set_ce(inner_iph);
398 static int ipip_rcv(struct sk_buff *skb)
400 struct ip_tunnel *tunnel;
401 const struct iphdr *iph = ip_hdr(skb);
404 tunnel = ipip_tunnel_lookup(dev_net(skb->dev), iph->saddr, iph->daddr);
405 if (tunnel != NULL) {
406 struct pcpu_tstats *tstats;
408 if (!xfrm4_policy_check(NULL, XFRM_POLICY_IN, skb)) {
416 skb->mac_header = skb->network_header;
417 skb_reset_network_header(skb);
418 skb->protocol = htons(ETH_P_IP);
419 skb->pkt_type = PACKET_HOST;
421 tstats = this_cpu_ptr(tunnel->dev->tstats);
422 u64_stats_update_begin(&tstats->syncp);
423 tstats->rx_packets++;
424 tstats->rx_bytes += skb->len;
425 u64_stats_update_end(&tstats->syncp);
427 __skb_tunnel_rx(skb, tunnel->dev);
429 ipip_ecn_decapsulate(iph, skb);
442 * This function assumes it is being called from dev_queue_xmit()
443 * and that skb is filled properly by that function.
446 static netdev_tx_t ipip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev)
448 struct ip_tunnel *tunnel = netdev_priv(dev);
449 struct pcpu_tstats *tstats;
450 const struct iphdr *tiph = &tunnel->parms.iph;
451 u8 tos = tunnel->parms.iph.tos;
452 __be16 df = tiph->frag_off;
453 struct rtable *rt; /* Route to the other host */
454 struct net_device *tdev; /* Device to other host */
455 const struct iphdr *old_iph = ip_hdr(skb);
456 struct iphdr *iph; /* Our new IP header */
457 unsigned int max_headroom; /* The extra header space needed */
458 __be32 dst = tiph->daddr;
462 if (skb->protocol != htons(ETH_P_IP))
470 if ((rt = skb_rtable(skb)) == NULL) {
471 dev->stats.tx_fifo_errors++;
474 dst = rt->rt_gateway;
477 rt = ip_route_output_ports(dev_net(dev), &fl4, NULL,
480 IPPROTO_IPIP, RT_TOS(tos),
483 dev->stats.tx_carrier_errors++;
490 dev->stats.collisions++;
494 df |= old_iph->frag_off & htons(IP_DF);
497 mtu = dst_mtu(&rt->dst) - sizeof(struct iphdr);
500 dev->stats.collisions++;
506 skb_dst(skb)->ops->update_pmtu(skb_dst(skb), mtu);
508 if ((old_iph->frag_off & htons(IP_DF)) &&
509 mtu < ntohs(old_iph->tot_len)) {
510 icmp_send(skb, ICMP_DEST_UNREACH, ICMP_FRAG_NEEDED,
517 if (tunnel->err_count > 0) {
518 if (time_before(jiffies,
519 tunnel->err_time + IPTUNNEL_ERR_TIMEO)) {
521 dst_link_failure(skb);
523 tunnel->err_count = 0;
527 * Okay, now see if we can stuff it in the buffer as-is.
529 max_headroom = (LL_RESERVED_SPACE(tdev)+sizeof(struct iphdr));
531 if (skb_headroom(skb) < max_headroom || skb_shared(skb) ||
532 (skb_cloned(skb) && !skb_clone_writable(skb, 0))) {
533 struct sk_buff *new_skb = skb_realloc_headroom(skb, max_headroom);
536 dev->stats.tx_dropped++;
541 skb_set_owner_w(new_skb, skb->sk);
544 old_iph = ip_hdr(skb);
547 skb->transport_header = skb->network_header;
548 skb_push(skb, sizeof(struct iphdr));
549 skb_reset_network_header(skb);
550 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
551 IPCB(skb)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
554 skb_dst_set(skb, &rt->dst);
557 * Push down and install the IPIP header.
562 iph->ihl = sizeof(struct iphdr)>>2;
564 iph->protocol = IPPROTO_IPIP;
565 iph->tos = INET_ECN_encapsulate(tos, old_iph->tos);
566 iph->daddr = fl4.daddr;
567 iph->saddr = fl4.saddr;
569 if ((iph->ttl = tiph->ttl) == 0)
570 iph->ttl = old_iph->ttl;
573 tstats = this_cpu_ptr(dev->tstats);
574 __IPTUNNEL_XMIT(tstats, &dev->stats);
578 dst_link_failure(skb);
580 dev->stats.tx_errors++;
585 static void ipip_tunnel_bind_dev(struct net_device *dev)
587 struct net_device *tdev = NULL;
588 struct ip_tunnel *tunnel;
589 const struct iphdr *iph;
591 tunnel = netdev_priv(dev);
592 iph = &tunnel->parms.iph;
598 rt = ip_route_output_ports(dev_net(dev), &fl4, NULL,
599 iph->daddr, iph->saddr,
608 dev->flags |= IFF_POINTOPOINT;
611 if (!tdev && tunnel->parms.link)
612 tdev = __dev_get_by_index(dev_net(dev), tunnel->parms.link);
615 dev->hard_header_len = tdev->hard_header_len + sizeof(struct iphdr);
616 dev->mtu = tdev->mtu - sizeof(struct iphdr);
618 dev->iflink = tunnel->parms.link;
622 ipip_tunnel_ioctl (struct net_device *dev, struct ifreq *ifr, int cmd)
625 struct ip_tunnel_parm p;
627 struct net *net = dev_net(dev);
628 struct ipip_net *ipn = net_generic(net, ipip_net_id);
633 if (dev == ipn->fb_tunnel_dev) {
634 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p))) {
638 t = ipip_tunnel_locate(net, &p, 0);
641 t = netdev_priv(dev);
642 memcpy(&p, &t->parms, sizeof(p));
643 if (copy_to_user(ifr->ifr_ifru.ifru_data, &p, sizeof(p)))
650 if (!capable(CAP_NET_ADMIN))
654 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
658 if (p.iph.version != 4 || p.iph.protocol != IPPROTO_IPIP ||
659 p.iph.ihl != 5 || (p.iph.frag_off&htons(~IP_DF)))
662 p.iph.frag_off |= htons(IP_DF);
664 t = ipip_tunnel_locate(net, &p, cmd == SIOCADDTUNNEL);
666 if (dev != ipn->fb_tunnel_dev && cmd == SIOCCHGTUNNEL) {
673 if (((dev->flags&IFF_POINTOPOINT) && !p.iph.daddr) ||
674 (!(dev->flags&IFF_POINTOPOINT) && p.iph.daddr)) {
678 t = netdev_priv(dev);
679 ipip_tunnel_unlink(ipn, t);
681 t->parms.iph.saddr = p.iph.saddr;
682 t->parms.iph.daddr = p.iph.daddr;
683 memcpy(dev->dev_addr, &p.iph.saddr, 4);
684 memcpy(dev->broadcast, &p.iph.daddr, 4);
685 ipip_tunnel_link(ipn, t);
686 netdev_state_change(dev);
692 if (cmd == SIOCCHGTUNNEL) {
693 t->parms.iph.ttl = p.iph.ttl;
694 t->parms.iph.tos = p.iph.tos;
695 t->parms.iph.frag_off = p.iph.frag_off;
696 if (t->parms.link != p.link) {
697 t->parms.link = p.link;
698 ipip_tunnel_bind_dev(dev);
699 netdev_state_change(dev);
702 if (copy_to_user(ifr->ifr_ifru.ifru_data, &t->parms, sizeof(p)))
705 err = (cmd == SIOCADDTUNNEL ? -ENOBUFS : -ENOENT);
710 if (!capable(CAP_NET_ADMIN))
713 if (dev == ipn->fb_tunnel_dev) {
715 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
718 if ((t = ipip_tunnel_locate(net, &p, 0)) == NULL)
721 if (t->dev == ipn->fb_tunnel_dev)
725 unregister_netdevice(dev);
737 static int ipip_tunnel_change_mtu(struct net_device *dev, int new_mtu)
739 if (new_mtu < 68 || new_mtu > 0xFFF8 - sizeof(struct iphdr))
745 static const struct net_device_ops ipip_netdev_ops = {
746 .ndo_uninit = ipip_tunnel_uninit,
747 .ndo_start_xmit = ipip_tunnel_xmit,
748 .ndo_do_ioctl = ipip_tunnel_ioctl,
749 .ndo_change_mtu = ipip_tunnel_change_mtu,
750 .ndo_get_stats64 = ipip_get_stats64,
753 static void ipip_dev_free(struct net_device *dev)
755 free_percpu(dev->tstats);
759 static void ipip_tunnel_setup(struct net_device *dev)
761 dev->netdev_ops = &ipip_netdev_ops;
762 dev->destructor = ipip_dev_free;
764 dev->type = ARPHRD_TUNNEL;
765 dev->hard_header_len = LL_MAX_HEADER + sizeof(struct iphdr);
766 dev->mtu = ETH_DATA_LEN - sizeof(struct iphdr);
767 dev->flags = IFF_NOARP;
770 dev->features |= NETIF_F_NETNS_LOCAL;
771 dev->features |= NETIF_F_LLTX;
772 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
775 static int ipip_tunnel_init(struct net_device *dev)
777 struct ip_tunnel *tunnel = netdev_priv(dev);
781 memcpy(dev->dev_addr, &tunnel->parms.iph.saddr, 4);
782 memcpy(dev->broadcast, &tunnel->parms.iph.daddr, 4);
784 ipip_tunnel_bind_dev(dev);
786 dev->tstats = alloc_percpu(struct pcpu_tstats);
793 static int __net_init ipip_fb_tunnel_init(struct net_device *dev)
795 struct ip_tunnel *tunnel = netdev_priv(dev);
796 struct iphdr *iph = &tunnel->parms.iph;
797 struct ipip_net *ipn = net_generic(dev_net(dev), ipip_net_id);
800 strcpy(tunnel->parms.name, dev->name);
803 iph->protocol = IPPROTO_IPIP;
806 dev->tstats = alloc_percpu(struct pcpu_tstats);
811 rcu_assign_pointer(ipn->tunnels_wc[0], tunnel);
815 static struct xfrm_tunnel ipip_handler __read_mostly = {
817 .err_handler = ipip_err,
821 static const char banner[] __initconst =
822 KERN_INFO "IPv4 over IPv4 tunneling driver\n";
824 static void ipip_destroy_tunnels(struct ipip_net *ipn, struct list_head *head)
828 for (prio = 1; prio < 4; prio++) {
830 for (h = 0; h < HASH_SIZE; h++) {
833 t = rtnl_dereference(ipn->tunnels[prio][h]);
835 unregister_netdevice_queue(t->dev, head);
836 t = rtnl_dereference(t->next);
842 static int __net_init ipip_init_net(struct net *net)
844 struct ipip_net *ipn = net_generic(net, ipip_net_id);
848 ipn->tunnels[0] = ipn->tunnels_wc;
849 ipn->tunnels[1] = ipn->tunnels_l;
850 ipn->tunnels[2] = ipn->tunnels_r;
851 ipn->tunnels[3] = ipn->tunnels_r_l;
853 ipn->fb_tunnel_dev = alloc_netdev(sizeof(struct ip_tunnel),
856 if (!ipn->fb_tunnel_dev) {
860 dev_net_set(ipn->fb_tunnel_dev, net);
862 err = ipip_fb_tunnel_init(ipn->fb_tunnel_dev);
866 if ((err = register_netdev(ipn->fb_tunnel_dev)))
869 t = netdev_priv(ipn->fb_tunnel_dev);
871 strcpy(t->parms.name, ipn->fb_tunnel_dev->name);
875 ipip_dev_free(ipn->fb_tunnel_dev);
881 static void __net_exit ipip_exit_net(struct net *net)
883 struct ipip_net *ipn = net_generic(net, ipip_net_id);
887 ipip_destroy_tunnels(ipn, &list);
888 unregister_netdevice_queue(ipn->fb_tunnel_dev, &list);
889 unregister_netdevice_many(&list);
893 static struct pernet_operations ipip_net_ops = {
894 .init = ipip_init_net,
895 .exit = ipip_exit_net,
897 .size = sizeof(struct ipip_net),
900 static int __init ipip_init(void)
906 err = register_pernet_device(&ipip_net_ops);
909 err = xfrm4_tunnel_register(&ipip_handler, AF_INET);
911 unregister_pernet_device(&ipip_net_ops);
912 pr_info("%s: can't register tunnel\n", __func__);
917 static void __exit ipip_fini(void)
919 if (xfrm4_tunnel_deregister(&ipip_handler, AF_INET))
920 pr_info("%s: can't deregister tunnel\n", __func__);
922 unregister_pernet_device(&ipip_net_ops);
925 module_init(ipip_init);
926 module_exit(ipip_fini);
927 MODULE_LICENSE("GPL");
928 MODULE_ALIAS_NETDEV("tunl0");