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 void ipip_tunnel_init(struct net_device *dev);
135 static void ipip_tunnel_setup(struct net_device *dev);
138 * Locking : hash tables are protected by RCU and RTNL
141 #define for_each_ip_tunnel_rcu(start) \
142 for (t = rcu_dereference(start); t; t = rcu_dereference(t->next))
144 static struct ip_tunnel * ipip_tunnel_lookup(struct net *net,
145 __be32 remote, __be32 local)
147 unsigned int h0 = HASH(remote);
148 unsigned int h1 = HASH(local);
150 struct ipip_net *ipn = net_generic(net, ipip_net_id);
152 for_each_ip_tunnel_rcu(ipn->tunnels_r_l[h0 ^ h1])
153 if (local == t->parms.iph.saddr &&
154 remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
157 for_each_ip_tunnel_rcu(ipn->tunnels_r[h0])
158 if (remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
161 for_each_ip_tunnel_rcu(ipn->tunnels_l[h1])
162 if (local == t->parms.iph.saddr && (t->dev->flags&IFF_UP))
165 t = rcu_dereference(ipn->tunnels_wc[0]);
166 if (t && (t->dev->flags&IFF_UP))
171 static struct ip_tunnel __rcu **__ipip_bucket(struct ipip_net *ipn,
172 struct ip_tunnel_parm *parms)
174 __be32 remote = parms->iph.daddr;
175 __be32 local = parms->iph.saddr;
187 return &ipn->tunnels[prio][h];
190 static inline struct ip_tunnel __rcu **ipip_bucket(struct ipip_net *ipn,
193 return __ipip_bucket(ipn, &t->parms);
196 static void ipip_tunnel_unlink(struct ipip_net *ipn, struct ip_tunnel *t)
198 struct ip_tunnel __rcu **tp;
199 struct ip_tunnel *iter;
201 for (tp = ipip_bucket(ipn, t);
202 (iter = rtnl_dereference(*tp)) != NULL;
205 rcu_assign_pointer(*tp, t->next);
211 static void ipip_tunnel_link(struct ipip_net *ipn, struct ip_tunnel *t)
213 struct ip_tunnel __rcu **tp = ipip_bucket(ipn, t);
215 rcu_assign_pointer(t->next, rtnl_dereference(*tp));
216 rcu_assign_pointer(*tp, t);
219 static struct ip_tunnel * ipip_tunnel_locate(struct net *net,
220 struct ip_tunnel_parm *parms, int create)
222 __be32 remote = parms->iph.daddr;
223 __be32 local = parms->iph.saddr;
224 struct ip_tunnel *t, *nt;
225 struct ip_tunnel __rcu **tp;
226 struct net_device *dev;
228 struct ipip_net *ipn = net_generic(net, ipip_net_id);
230 for (tp = __ipip_bucket(ipn, parms);
231 (t = rtnl_dereference(*tp)) != NULL;
233 if (local == t->parms.iph.saddr && remote == t->parms.iph.daddr)
240 strlcpy(name, parms->name, IFNAMSIZ);
242 sprintf(name, "tunl%%d");
244 dev = alloc_netdev(sizeof(*t), name, ipip_tunnel_setup);
248 dev_net_set(dev, net);
250 if (strchr(name, '%')) {
251 if (dev_alloc_name(dev, name) < 0)
255 nt = netdev_priv(dev);
258 ipip_tunnel_init(dev);
260 if (register_netdevice(dev) < 0)
264 ipip_tunnel_link(ipn, nt);
272 /* called with RTNL */
273 static void ipip_tunnel_uninit(struct net_device *dev)
275 struct net *net = dev_net(dev);
276 struct ipip_net *ipn = net_generic(net, ipip_net_id);
278 if (dev == ipn->fb_tunnel_dev)
279 rcu_assign_pointer(ipn->tunnels_wc[0], NULL);
281 ipip_tunnel_unlink(ipn, netdev_priv(dev));
285 static int ipip_err(struct sk_buff *skb, u32 info)
288 /* All the routers (except for Linux) return only
289 8 bytes of packet payload. It means, that precise relaying of
290 ICMP in the real Internet is absolutely infeasible.
292 struct iphdr *iph = (struct iphdr *)skb->data;
293 const int type = icmp_hdr(skb)->type;
294 const int code = icmp_hdr(skb)->code;
300 case ICMP_PARAMETERPROB:
303 case ICMP_DEST_UNREACH:
306 case ICMP_PORT_UNREACH:
307 /* Impossible event. */
309 case ICMP_FRAG_NEEDED:
310 /* Soft state for pmtu is maintained by IP core. */
313 /* All others are translated to HOST_UNREACH.
314 rfc2003 contains "deep thoughts" about NET_UNREACH,
315 I believe they are just ether pollution. --ANK
320 case ICMP_TIME_EXCEEDED:
321 if (code != ICMP_EXC_TTL)
329 t = ipip_tunnel_lookup(dev_net(skb->dev), iph->daddr, iph->saddr);
330 if (t == NULL || t->parms.iph.daddr == 0)
334 if (t->parms.iph.ttl == 0 && type == ICMP_TIME_EXCEEDED)
337 if (time_before(jiffies, t->err_time + IPTUNNEL_ERR_TIMEO))
341 t->err_time = jiffies;
347 static inline void ipip_ecn_decapsulate(const struct iphdr *outer_iph,
350 struct iphdr *inner_iph = ip_hdr(skb);
352 if (INET_ECN_is_ce(outer_iph->tos))
353 IP_ECN_set_ce(inner_iph);
356 static int ipip_rcv(struct sk_buff *skb)
358 struct ip_tunnel *tunnel;
359 const struct iphdr *iph = ip_hdr(skb);
362 if ((tunnel = ipip_tunnel_lookup(dev_net(skb->dev),
363 iph->saddr, iph->daddr)) != NULL) {
364 if (!xfrm4_policy_check(NULL, XFRM_POLICY_IN, skb)) {
372 skb->mac_header = skb->network_header;
373 skb_reset_network_header(skb);
374 skb->protocol = htons(ETH_P_IP);
375 skb->pkt_type = PACKET_HOST;
377 skb_tunnel_rx(skb, tunnel->dev);
379 ipip_ecn_decapsulate(iph, skb);
381 if (netif_rx(skb) == NET_RX_DROP)
382 tunnel->dev->stats.rx_dropped++;
393 * This function assumes it is being called from dev_queue_xmit()
394 * and that skb is filled properly by that function.
397 static netdev_tx_t ipip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev)
399 struct ip_tunnel *tunnel = netdev_priv(dev);
400 struct net_device_stats *stats = &dev->stats;
401 struct netdev_queue *txq = netdev_get_tx_queue(dev, 0);
402 struct iphdr *tiph = &tunnel->parms.iph;
403 u8 tos = tunnel->parms.iph.tos;
404 __be16 df = tiph->frag_off;
405 struct rtable *rt; /* Route to the other host */
406 struct net_device *tdev; /* Device to other host */
407 struct iphdr *old_iph = ip_hdr(skb);
408 struct iphdr *iph; /* Our new IP header */
409 unsigned int max_headroom; /* The extra header space needed */
410 __be32 dst = tiph->daddr;
413 if (skb->protocol != htons(ETH_P_IP))
421 if ((rt = skb_rtable(skb)) == NULL) {
422 stats->tx_fifo_errors++;
425 if ((dst = rt->rt_gateway) == 0)
430 struct flowi fl = { .oif = tunnel->parms.link,
433 .saddr = tiph->saddr,
434 .tos = RT_TOS(tos) } },
435 .proto = IPPROTO_IPIP };
436 if (ip_route_output_key(dev_net(dev), &rt, &fl)) {
437 stats->tx_carrier_errors++;
449 df |= old_iph->frag_off & htons(IP_DF);
452 mtu = dst_mtu(&rt->dst) - sizeof(struct iphdr);
461 skb_dst(skb)->ops->update_pmtu(skb_dst(skb), mtu);
463 if ((old_iph->frag_off & htons(IP_DF)) &&
464 mtu < ntohs(old_iph->tot_len)) {
465 icmp_send(skb, ICMP_DEST_UNREACH, ICMP_FRAG_NEEDED,
472 if (tunnel->err_count > 0) {
473 if (time_before(jiffies,
474 tunnel->err_time + IPTUNNEL_ERR_TIMEO)) {
476 dst_link_failure(skb);
478 tunnel->err_count = 0;
482 * Okay, now see if we can stuff it in the buffer as-is.
484 max_headroom = (LL_RESERVED_SPACE(tdev)+sizeof(struct iphdr));
486 if (skb_headroom(skb) < max_headroom || skb_shared(skb) ||
487 (skb_cloned(skb) && !skb_clone_writable(skb, 0))) {
488 struct sk_buff *new_skb = skb_realloc_headroom(skb, max_headroom);
496 skb_set_owner_w(new_skb, skb->sk);
499 old_iph = ip_hdr(skb);
502 skb->transport_header = skb->network_header;
503 skb_push(skb, sizeof(struct iphdr));
504 skb_reset_network_header(skb);
505 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
506 IPCB(skb)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
509 skb_dst_set(skb, &rt->dst);
512 * Push down and install the IPIP header.
517 iph->ihl = sizeof(struct iphdr)>>2;
519 iph->protocol = IPPROTO_IPIP;
520 iph->tos = INET_ECN_encapsulate(tos, old_iph->tos);
521 iph->daddr = rt->rt_dst;
522 iph->saddr = rt->rt_src;
524 if ((iph->ttl = tiph->ttl) == 0)
525 iph->ttl = old_iph->ttl;
533 dst_link_failure(skb);
540 static void ipip_tunnel_bind_dev(struct net_device *dev)
542 struct net_device *tdev = NULL;
543 struct ip_tunnel *tunnel;
546 tunnel = netdev_priv(dev);
547 iph = &tunnel->parms.iph;
550 struct flowi fl = { .oif = tunnel->parms.link,
552 { .daddr = iph->daddr,
554 .tos = RT_TOS(iph->tos) } },
555 .proto = IPPROTO_IPIP };
557 if (!ip_route_output_key(dev_net(dev), &rt, &fl)) {
561 dev->flags |= IFF_POINTOPOINT;
564 if (!tdev && tunnel->parms.link)
565 tdev = __dev_get_by_index(dev_net(dev), tunnel->parms.link);
568 dev->hard_header_len = tdev->hard_header_len + sizeof(struct iphdr);
569 dev->mtu = tdev->mtu - sizeof(struct iphdr);
571 dev->iflink = tunnel->parms.link;
575 ipip_tunnel_ioctl (struct net_device *dev, struct ifreq *ifr, int cmd)
578 struct ip_tunnel_parm p;
580 struct net *net = dev_net(dev);
581 struct ipip_net *ipn = net_generic(net, ipip_net_id);
586 if (dev == ipn->fb_tunnel_dev) {
587 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p))) {
591 t = ipip_tunnel_locate(net, &p, 0);
594 t = netdev_priv(dev);
595 memcpy(&p, &t->parms, sizeof(p));
596 if (copy_to_user(ifr->ifr_ifru.ifru_data, &p, sizeof(p)))
603 if (!capable(CAP_NET_ADMIN))
607 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
611 if (p.iph.version != 4 || p.iph.protocol != IPPROTO_IPIP ||
612 p.iph.ihl != 5 || (p.iph.frag_off&htons(~IP_DF)))
615 p.iph.frag_off |= htons(IP_DF);
617 t = ipip_tunnel_locate(net, &p, cmd == SIOCADDTUNNEL);
619 if (dev != ipn->fb_tunnel_dev && cmd == SIOCCHGTUNNEL) {
626 if (((dev->flags&IFF_POINTOPOINT) && !p.iph.daddr) ||
627 (!(dev->flags&IFF_POINTOPOINT) && p.iph.daddr)) {
631 t = netdev_priv(dev);
632 ipip_tunnel_unlink(ipn, t);
633 t->parms.iph.saddr = p.iph.saddr;
634 t->parms.iph.daddr = p.iph.daddr;
635 memcpy(dev->dev_addr, &p.iph.saddr, 4);
636 memcpy(dev->broadcast, &p.iph.daddr, 4);
637 ipip_tunnel_link(ipn, t);
638 netdev_state_change(dev);
644 if (cmd == SIOCCHGTUNNEL) {
645 t->parms.iph.ttl = p.iph.ttl;
646 t->parms.iph.tos = p.iph.tos;
647 t->parms.iph.frag_off = p.iph.frag_off;
648 if (t->parms.link != p.link) {
649 t->parms.link = p.link;
650 ipip_tunnel_bind_dev(dev);
651 netdev_state_change(dev);
654 if (copy_to_user(ifr->ifr_ifru.ifru_data, &t->parms, sizeof(p)))
657 err = (cmd == SIOCADDTUNNEL ? -ENOBUFS : -ENOENT);
662 if (!capable(CAP_NET_ADMIN))
665 if (dev == ipn->fb_tunnel_dev) {
667 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
670 if ((t = ipip_tunnel_locate(net, &p, 0)) == NULL)
673 if (t->dev == ipn->fb_tunnel_dev)
677 unregister_netdevice(dev);
689 static int ipip_tunnel_change_mtu(struct net_device *dev, int new_mtu)
691 if (new_mtu < 68 || new_mtu > 0xFFF8 - sizeof(struct iphdr))
697 static const struct net_device_ops ipip_netdev_ops = {
698 .ndo_uninit = ipip_tunnel_uninit,
699 .ndo_start_xmit = ipip_tunnel_xmit,
700 .ndo_do_ioctl = ipip_tunnel_ioctl,
701 .ndo_change_mtu = ipip_tunnel_change_mtu,
705 static void ipip_tunnel_setup(struct net_device *dev)
707 dev->netdev_ops = &ipip_netdev_ops;
708 dev->destructor = free_netdev;
710 dev->type = ARPHRD_TUNNEL;
711 dev->hard_header_len = LL_MAX_HEADER + sizeof(struct iphdr);
712 dev->mtu = ETH_DATA_LEN - sizeof(struct iphdr);
713 dev->flags = IFF_NOARP;
716 dev->features |= NETIF_F_NETNS_LOCAL;
717 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
720 static void ipip_tunnel_init(struct net_device *dev)
722 struct ip_tunnel *tunnel = netdev_priv(dev);
725 strcpy(tunnel->parms.name, dev->name);
727 memcpy(dev->dev_addr, &tunnel->parms.iph.saddr, 4);
728 memcpy(dev->broadcast, &tunnel->parms.iph.daddr, 4);
730 ipip_tunnel_bind_dev(dev);
733 static void __net_init ipip_fb_tunnel_init(struct net_device *dev)
735 struct ip_tunnel *tunnel = netdev_priv(dev);
736 struct iphdr *iph = &tunnel->parms.iph;
737 struct ipip_net *ipn = net_generic(dev_net(dev), ipip_net_id);
740 strcpy(tunnel->parms.name, dev->name);
743 iph->protocol = IPPROTO_IPIP;
747 rcu_assign_pointer(ipn->tunnels_wc[0], tunnel);
750 static struct xfrm_tunnel ipip_handler __read_mostly = {
752 .err_handler = ipip_err,
756 static const char banner[] __initconst =
757 KERN_INFO "IPv4 over IPv4 tunneling driver\n";
759 static void ipip_destroy_tunnels(struct ipip_net *ipn, struct list_head *head)
763 for (prio = 1; prio < 4; prio++) {
765 for (h = 0; h < HASH_SIZE; h++) {
768 t = rtnl_dereference(ipn->tunnels[prio][h]);
770 unregister_netdevice_queue(t->dev, head);
771 t = rtnl_dereference(t->next);
777 static int __net_init ipip_init_net(struct net *net)
779 struct ipip_net *ipn = net_generic(net, ipip_net_id);
782 ipn->tunnels[0] = ipn->tunnels_wc;
783 ipn->tunnels[1] = ipn->tunnels_l;
784 ipn->tunnels[2] = ipn->tunnels_r;
785 ipn->tunnels[3] = ipn->tunnels_r_l;
787 ipn->fb_tunnel_dev = alloc_netdev(sizeof(struct ip_tunnel),
790 if (!ipn->fb_tunnel_dev) {
794 dev_net_set(ipn->fb_tunnel_dev, net);
796 ipip_fb_tunnel_init(ipn->fb_tunnel_dev);
798 if ((err = register_netdev(ipn->fb_tunnel_dev)))
804 free_netdev(ipn->fb_tunnel_dev);
810 static void __net_exit ipip_exit_net(struct net *net)
812 struct ipip_net *ipn = net_generic(net, ipip_net_id);
816 ipip_destroy_tunnels(ipn, &list);
817 unregister_netdevice_queue(ipn->fb_tunnel_dev, &list);
818 unregister_netdevice_many(&list);
822 static struct pernet_operations ipip_net_ops = {
823 .init = ipip_init_net,
824 .exit = ipip_exit_net,
826 .size = sizeof(struct ipip_net),
829 static int __init ipip_init(void)
835 err = register_pernet_device(&ipip_net_ops);
838 err = xfrm4_tunnel_register(&ipip_handler, AF_INET);
840 unregister_pernet_device(&ipip_net_ops);
841 printk(KERN_INFO "ipip init: can't register tunnel\n");
846 static void __exit ipip_fini(void)
848 if (xfrm4_tunnel_deregister(&ipip_handler, AF_INET))
849 printk(KERN_INFO "ipip close: can't deregister tunnel\n");
851 unregister_pernet_device(&ipip_net_ops);
854 module_init(ipip_init);
855 module_exit(ipip_fini);
856 MODULE_LICENSE("GPL");