2 * Linux NET3: IP/IP protocol decoder.
5 * Sam Lantinga (slouken@cs.ucdavis.edu) 02/01/95
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!
35 -Sam Lantinga (slouken@cs.ucdavis.edu) 02/01/95
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.
44 -Alan Cox (alan@lxorguk.ukuu.org.uk) 21 March 95
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.
52 -Sam Lantinga (slouken@cs.ucdavis.edu) 02/13/96
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) */
147 unsigned long rx_packets;
148 unsigned long rx_bytes;
149 unsigned long tx_packets;
150 unsigned long tx_bytes;
153 static struct net_device_stats *ipip_get_stats(struct net_device *dev)
155 struct pcpu_tstats sum = { 0 };
158 for_each_possible_cpu(i) {
159 const struct pcpu_tstats *tstats = per_cpu_ptr(dev->tstats, i);
161 sum.rx_packets += tstats->rx_packets;
162 sum.rx_bytes += tstats->rx_bytes;
163 sum.tx_packets += tstats->tx_packets;
164 sum.tx_bytes += tstats->tx_bytes;
166 dev->stats.rx_packets = sum.rx_packets;
167 dev->stats.rx_bytes = sum.rx_bytes;
168 dev->stats.tx_packets = sum.tx_packets;
169 dev->stats.tx_bytes = sum.tx_bytes;
173 static struct ip_tunnel * ipip_tunnel_lookup(struct net *net,
174 __be32 remote, __be32 local)
176 unsigned int h0 = HASH(remote);
177 unsigned int h1 = HASH(local);
179 struct ipip_net *ipn = net_generic(net, ipip_net_id);
181 for_each_ip_tunnel_rcu(ipn->tunnels_r_l[h0 ^ h1])
182 if (local == t->parms.iph.saddr &&
183 remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
186 for_each_ip_tunnel_rcu(ipn->tunnels_r[h0])
187 if (remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
190 for_each_ip_tunnel_rcu(ipn->tunnels_l[h1])
191 if (local == t->parms.iph.saddr && (t->dev->flags&IFF_UP))
194 t = rcu_dereference(ipn->tunnels_wc[0]);
195 if (t && (t->dev->flags&IFF_UP))
200 static struct ip_tunnel __rcu **__ipip_bucket(struct ipip_net *ipn,
201 struct ip_tunnel_parm *parms)
203 __be32 remote = parms->iph.daddr;
204 __be32 local = parms->iph.saddr;
216 return &ipn->tunnels[prio][h];
219 static inline struct ip_tunnel __rcu **ipip_bucket(struct ipip_net *ipn,
222 return __ipip_bucket(ipn, &t->parms);
225 static void ipip_tunnel_unlink(struct ipip_net *ipn, struct ip_tunnel *t)
227 struct ip_tunnel __rcu **tp;
228 struct ip_tunnel *iter;
230 for (tp = ipip_bucket(ipn, t);
231 (iter = rtnl_dereference(*tp)) != NULL;
234 rcu_assign_pointer(*tp, t->next);
240 static void ipip_tunnel_link(struct ipip_net *ipn, struct ip_tunnel *t)
242 struct ip_tunnel __rcu **tp = ipip_bucket(ipn, t);
244 rcu_assign_pointer(t->next, rtnl_dereference(*tp));
245 rcu_assign_pointer(*tp, t);
248 static struct ip_tunnel * ipip_tunnel_locate(struct net *net,
249 struct ip_tunnel_parm *parms, int create)
251 __be32 remote = parms->iph.daddr;
252 __be32 local = parms->iph.saddr;
253 struct ip_tunnel *t, *nt;
254 struct ip_tunnel __rcu **tp;
255 struct net_device *dev;
257 struct ipip_net *ipn = net_generic(net, ipip_net_id);
259 for (tp = __ipip_bucket(ipn, parms);
260 (t = rtnl_dereference(*tp)) != NULL;
262 if (local == t->parms.iph.saddr && remote == t->parms.iph.daddr)
269 strlcpy(name, parms->name, IFNAMSIZ);
271 strcpy(name, "tunl%d");
273 dev = alloc_netdev(sizeof(*t), name, ipip_tunnel_setup);
277 dev_net_set(dev, net);
279 nt = netdev_priv(dev);
282 if (ipip_tunnel_init(dev) < 0)
285 if (register_netdevice(dev) < 0)
289 ipip_tunnel_link(ipn, nt);
297 /* called with RTNL */
298 static void ipip_tunnel_uninit(struct net_device *dev)
300 struct net *net = dev_net(dev);
301 struct ipip_net *ipn = net_generic(net, ipip_net_id);
303 if (dev == ipn->fb_tunnel_dev)
304 rcu_assign_pointer(ipn->tunnels_wc[0], NULL);
306 ipip_tunnel_unlink(ipn, netdev_priv(dev));
310 static int ipip_err(struct sk_buff *skb, u32 info)
313 /* All the routers (except for Linux) return only
314 8 bytes of packet payload. It means, that precise relaying of
315 ICMP in the real Internet is absolutely infeasible.
317 const struct iphdr *iph = (const struct iphdr *)skb->data;
318 const int type = icmp_hdr(skb)->type;
319 const int code = icmp_hdr(skb)->code;
325 case ICMP_PARAMETERPROB:
328 case ICMP_DEST_UNREACH:
331 case ICMP_PORT_UNREACH:
332 /* Impossible event. */
334 case ICMP_FRAG_NEEDED:
335 /* Soft state for pmtu is maintained by IP core. */
338 /* All others are translated to HOST_UNREACH.
339 rfc2003 contains "deep thoughts" about NET_UNREACH,
340 I believe they are just ether pollution. --ANK
345 case ICMP_TIME_EXCEEDED:
346 if (code != ICMP_EXC_TTL)
354 t = ipip_tunnel_lookup(dev_net(skb->dev), iph->daddr, iph->saddr);
355 if (t == NULL || t->parms.iph.daddr == 0)
359 if (t->parms.iph.ttl == 0 && type == ICMP_TIME_EXCEEDED)
362 if (time_before(jiffies, t->err_time + IPTUNNEL_ERR_TIMEO))
366 t->err_time = jiffies;
372 static inline void ipip_ecn_decapsulate(const struct iphdr *outer_iph,
375 struct iphdr *inner_iph = ip_hdr(skb);
377 if (INET_ECN_is_ce(outer_iph->tos))
378 IP_ECN_set_ce(inner_iph);
381 static int ipip_rcv(struct sk_buff *skb)
383 struct ip_tunnel *tunnel;
384 const struct iphdr *iph = ip_hdr(skb);
387 tunnel = ipip_tunnel_lookup(dev_net(skb->dev), iph->saddr, iph->daddr);
388 if (tunnel != NULL) {
389 struct pcpu_tstats *tstats;
391 if (!xfrm4_policy_check(NULL, XFRM_POLICY_IN, skb)) {
399 skb->mac_header = skb->network_header;
400 skb_reset_network_header(skb);
401 skb->protocol = htons(ETH_P_IP);
402 skb->pkt_type = PACKET_HOST;
404 tstats = this_cpu_ptr(tunnel->dev->tstats);
405 tstats->rx_packets++;
406 tstats->rx_bytes += skb->len;
408 __skb_tunnel_rx(skb, tunnel->dev);
410 ipip_ecn_decapsulate(iph, skb);
423 * This function assumes it is being called from dev_queue_xmit()
424 * and that skb is filled properly by that function.
427 static netdev_tx_t ipip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev)
429 struct ip_tunnel *tunnel = netdev_priv(dev);
430 struct pcpu_tstats *tstats;
431 const struct iphdr *tiph = &tunnel->parms.iph;
432 u8 tos = tunnel->parms.iph.tos;
433 __be16 df = tiph->frag_off;
434 struct rtable *rt; /* Route to the other host */
435 struct net_device *tdev; /* Device to other host */
436 const struct iphdr *old_iph = ip_hdr(skb);
437 struct iphdr *iph; /* Our new IP header */
438 unsigned int max_headroom; /* The extra header space needed */
439 __be32 dst = tiph->daddr;
443 if (skb->protocol != htons(ETH_P_IP))
451 if ((rt = skb_rtable(skb)) == NULL) {
452 dev->stats.tx_fifo_errors++;
455 if ((dst = rt->rt_gateway) == 0)
459 rt = ip_route_output_ports(dev_net(dev), &fl4, NULL,
462 IPPROTO_IPIP, RT_TOS(tos),
465 dev->stats.tx_carrier_errors++;
472 dev->stats.collisions++;
476 df |= old_iph->frag_off & htons(IP_DF);
479 mtu = dst_mtu(&rt->dst) - sizeof(struct iphdr);
482 dev->stats.collisions++;
488 skb_dst(skb)->ops->update_pmtu(skb_dst(skb), mtu);
490 if ((old_iph->frag_off & htons(IP_DF)) &&
491 mtu < ntohs(old_iph->tot_len)) {
492 icmp_send(skb, ICMP_DEST_UNREACH, ICMP_FRAG_NEEDED,
499 if (tunnel->err_count > 0) {
500 if (time_before(jiffies,
501 tunnel->err_time + IPTUNNEL_ERR_TIMEO)) {
503 dst_link_failure(skb);
505 tunnel->err_count = 0;
509 * Okay, now see if we can stuff it in the buffer as-is.
511 max_headroom = (LL_RESERVED_SPACE(tdev)+sizeof(struct iphdr));
513 if (skb_headroom(skb) < max_headroom || skb_shared(skb) ||
514 (skb_cloned(skb) && !skb_clone_writable(skb, 0))) {
515 struct sk_buff *new_skb = skb_realloc_headroom(skb, max_headroom);
518 dev->stats.tx_dropped++;
523 skb_set_owner_w(new_skb, skb->sk);
526 old_iph = ip_hdr(skb);
529 skb->transport_header = skb->network_header;
530 skb_push(skb, sizeof(struct iphdr));
531 skb_reset_network_header(skb);
532 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
533 IPCB(skb)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
536 skb_dst_set(skb, &rt->dst);
539 * Push down and install the IPIP header.
544 iph->ihl = sizeof(struct iphdr)>>2;
546 iph->protocol = IPPROTO_IPIP;
547 iph->tos = INET_ECN_encapsulate(tos, old_iph->tos);
548 iph->daddr = fl4.daddr;
549 iph->saddr = fl4.saddr;
551 if ((iph->ttl = tiph->ttl) == 0)
552 iph->ttl = old_iph->ttl;
555 tstats = this_cpu_ptr(dev->tstats);
556 __IPTUNNEL_XMIT(tstats, &dev->stats);
560 dst_link_failure(skb);
562 dev->stats.tx_errors++;
567 static void ipip_tunnel_bind_dev(struct net_device *dev)
569 struct net_device *tdev = NULL;
570 struct ip_tunnel *tunnel;
571 const struct iphdr *iph;
573 tunnel = netdev_priv(dev);
574 iph = &tunnel->parms.iph;
580 rt = ip_route_output_ports(dev_net(dev), &fl4, NULL,
581 iph->daddr, iph->saddr,
590 dev->flags |= IFF_POINTOPOINT;
593 if (!tdev && tunnel->parms.link)
594 tdev = __dev_get_by_index(dev_net(dev), tunnel->parms.link);
597 dev->hard_header_len = tdev->hard_header_len + sizeof(struct iphdr);
598 dev->mtu = tdev->mtu - sizeof(struct iphdr);
600 dev->iflink = tunnel->parms.link;
604 ipip_tunnel_ioctl (struct net_device *dev, struct ifreq *ifr, int cmd)
607 struct ip_tunnel_parm p;
609 struct net *net = dev_net(dev);
610 struct ipip_net *ipn = net_generic(net, ipip_net_id);
615 if (dev == ipn->fb_tunnel_dev) {
616 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p))) {
620 t = ipip_tunnel_locate(net, &p, 0);
623 t = netdev_priv(dev);
624 memcpy(&p, &t->parms, sizeof(p));
625 if (copy_to_user(ifr->ifr_ifru.ifru_data, &p, sizeof(p)))
632 if (!capable(CAP_NET_ADMIN))
636 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
640 if (p.iph.version != 4 || p.iph.protocol != IPPROTO_IPIP ||
641 p.iph.ihl != 5 || (p.iph.frag_off&htons(~IP_DF)))
644 p.iph.frag_off |= htons(IP_DF);
646 t = ipip_tunnel_locate(net, &p, cmd == SIOCADDTUNNEL);
648 if (dev != ipn->fb_tunnel_dev && cmd == SIOCCHGTUNNEL) {
655 if (((dev->flags&IFF_POINTOPOINT) && !p.iph.daddr) ||
656 (!(dev->flags&IFF_POINTOPOINT) && p.iph.daddr)) {
660 t = netdev_priv(dev);
661 ipip_tunnel_unlink(ipn, t);
663 t->parms.iph.saddr = p.iph.saddr;
664 t->parms.iph.daddr = p.iph.daddr;
665 memcpy(dev->dev_addr, &p.iph.saddr, 4);
666 memcpy(dev->broadcast, &p.iph.daddr, 4);
667 ipip_tunnel_link(ipn, t);
668 netdev_state_change(dev);
674 if (cmd == SIOCCHGTUNNEL) {
675 t->parms.iph.ttl = p.iph.ttl;
676 t->parms.iph.tos = p.iph.tos;
677 t->parms.iph.frag_off = p.iph.frag_off;
678 if (t->parms.link != p.link) {
679 t->parms.link = p.link;
680 ipip_tunnel_bind_dev(dev);
681 netdev_state_change(dev);
684 if (copy_to_user(ifr->ifr_ifru.ifru_data, &t->parms, sizeof(p)))
687 err = (cmd == SIOCADDTUNNEL ? -ENOBUFS : -ENOENT);
692 if (!capable(CAP_NET_ADMIN))
695 if (dev == ipn->fb_tunnel_dev) {
697 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
700 if ((t = ipip_tunnel_locate(net, &p, 0)) == NULL)
703 if (t->dev == ipn->fb_tunnel_dev)
707 unregister_netdevice(dev);
719 static int ipip_tunnel_change_mtu(struct net_device *dev, int new_mtu)
721 if (new_mtu < 68 || new_mtu > 0xFFF8 - sizeof(struct iphdr))
727 static const struct net_device_ops ipip_netdev_ops = {
728 .ndo_uninit = ipip_tunnel_uninit,
729 .ndo_start_xmit = ipip_tunnel_xmit,
730 .ndo_do_ioctl = ipip_tunnel_ioctl,
731 .ndo_change_mtu = ipip_tunnel_change_mtu,
732 .ndo_get_stats = ipip_get_stats,
735 static void ipip_dev_free(struct net_device *dev)
737 free_percpu(dev->tstats);
741 static void ipip_tunnel_setup(struct net_device *dev)
743 dev->netdev_ops = &ipip_netdev_ops;
744 dev->destructor = ipip_dev_free;
746 dev->type = ARPHRD_TUNNEL;
747 dev->hard_header_len = LL_MAX_HEADER + sizeof(struct iphdr);
748 dev->mtu = ETH_DATA_LEN - sizeof(struct iphdr);
749 dev->flags = IFF_NOARP;
752 dev->features |= NETIF_F_NETNS_LOCAL;
753 dev->features |= NETIF_F_LLTX;
754 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
757 static int ipip_tunnel_init(struct net_device *dev)
759 struct ip_tunnel *tunnel = netdev_priv(dev);
762 strcpy(tunnel->parms.name, dev->name);
764 memcpy(dev->dev_addr, &tunnel->parms.iph.saddr, 4);
765 memcpy(dev->broadcast, &tunnel->parms.iph.daddr, 4);
767 ipip_tunnel_bind_dev(dev);
769 dev->tstats = alloc_percpu(struct pcpu_tstats);
776 static int __net_init ipip_fb_tunnel_init(struct net_device *dev)
778 struct ip_tunnel *tunnel = netdev_priv(dev);
779 struct iphdr *iph = &tunnel->parms.iph;
780 struct ipip_net *ipn = net_generic(dev_net(dev), ipip_net_id);
783 strcpy(tunnel->parms.name, dev->name);
786 iph->protocol = IPPROTO_IPIP;
789 dev->tstats = alloc_percpu(struct pcpu_tstats);
794 rcu_assign_pointer(ipn->tunnels_wc[0], tunnel);
798 static struct xfrm_tunnel ipip_handler __read_mostly = {
800 .err_handler = ipip_err,
804 static const char banner[] __initconst =
805 KERN_INFO "IPv4 over IPv4 tunneling driver\n";
807 static void ipip_destroy_tunnels(struct ipip_net *ipn, struct list_head *head)
811 for (prio = 1; prio < 4; prio++) {
813 for (h = 0; h < HASH_SIZE; h++) {
816 t = rtnl_dereference(ipn->tunnels[prio][h]);
818 unregister_netdevice_queue(t->dev, head);
819 t = rtnl_dereference(t->next);
825 static int __net_init ipip_init_net(struct net *net)
827 struct ipip_net *ipn = net_generic(net, ipip_net_id);
830 ipn->tunnels[0] = ipn->tunnels_wc;
831 ipn->tunnels[1] = ipn->tunnels_l;
832 ipn->tunnels[2] = ipn->tunnels_r;
833 ipn->tunnels[3] = ipn->tunnels_r_l;
835 ipn->fb_tunnel_dev = alloc_netdev(sizeof(struct ip_tunnel),
838 if (!ipn->fb_tunnel_dev) {
842 dev_net_set(ipn->fb_tunnel_dev, net);
844 err = ipip_fb_tunnel_init(ipn->fb_tunnel_dev);
848 if ((err = register_netdev(ipn->fb_tunnel_dev)))
854 ipip_dev_free(ipn->fb_tunnel_dev);
860 static void __net_exit ipip_exit_net(struct net *net)
862 struct ipip_net *ipn = net_generic(net, ipip_net_id);
866 ipip_destroy_tunnels(ipn, &list);
867 unregister_netdevice_queue(ipn->fb_tunnel_dev, &list);
868 unregister_netdevice_many(&list);
872 static struct pernet_operations ipip_net_ops = {
873 .init = ipip_init_net,
874 .exit = ipip_exit_net,
876 .size = sizeof(struct ipip_net),
879 static int __init ipip_init(void)
885 err = register_pernet_device(&ipip_net_ops);
888 err = xfrm4_tunnel_register(&ipip_handler, AF_INET);
890 unregister_pernet_device(&ipip_net_ops);
891 printk(KERN_INFO "ipip init: can't register tunnel\n");
896 static void __exit ipip_fini(void)
898 if (xfrm4_tunnel_deregister(&ipip_handler, AF_INET))
899 printk(KERN_INFO "ipip close: can't deregister tunnel\n");
901 unregister_pernet_device(&ipip_net_ops);
904 module_init(ipip_init);
905 module_exit(ipip_fini);
906 MODULE_LICENSE("GPL");
907 MODULE_ALIAS_NETDEV("tunl0");