2 * Linux NET3: IP/IP protocol decoder.
4 * Version: $Id: ipip.c,v 1.50 2001/10/02 02:22:36 davem Exp $
7 * Sam Lantinga (slouken@cs.ucdavis.edu) 02/01/95
10 * Alan Cox : Merged and made usable non modular (its so tiny its silly as
11 * a module taking up 2 pages).
12 * Alan Cox : Fixed bug with 1.3.18 and IPIP not working (now needs to set skb->h.iph)
13 * to keep ip_forward happy.
14 * Alan Cox : More fixes for 1.3.21, and firewall fix. Maybe this will work soon 8).
15 * Kai Schulte : Fixed #defines for IP_FIREWALL->FIREWALL
16 * David Woodhouse : Perform some basic ICMP handling.
17 * IPIP Routing without decapsulation.
18 * Carlos Picoto : GRE over IP support
19 * Alexey Kuznetsov: Reworked. Really, now it is truncated version of ipv4/ip_gre.c.
20 * I do not want to merge them together.
22 * This program is free software; you can redistribute it and/or
23 * modify it under the terms of the GNU General Public License
24 * as published by the Free Software Foundation; either version
25 * 2 of the License, or (at your option) any later version.
29 /* tunnel.c: an IP tunnel driver
31 The purpose of this driver is to provide an IP tunnel through
32 which you can tunnel network traffic transparently across subnets.
34 This was written by looking at Nick Holloway's dummy driver
35 Thanks for the great code!
37 -Sam Lantinga (slouken@cs.ucdavis.edu) 02/01/95
40 Cleaned up the code a little and added some pre-1.3.0 tweaks.
41 dev->hard_header/hard_header_len changed to use no headers.
42 Comments/bracketing tweaked.
43 Made the tunnels use dev->name not tunnel: when error reporting.
46 -Alan Cox (Alan.Cox@linux.org) 21 March 95
49 Changed to tunnel to destination gateway in addition to the
50 tunnel's pointopoint address
51 Almost completely rewritten
52 Note: There is currently no firewall or ICMP handling done.
54 -Sam Lantinga (slouken@cs.ucdavis.edu) 02/13/96
58 /* Things I wish I had known when writing the tunnel driver:
60 When the tunnel_xmit() function is called, the skb contains the
61 packet to be sent (plus a great deal of extra info), and dev
62 contains the tunnel device that _we_ are.
64 When we are passed a packet, we are expected to fill in the
65 source address with our source IP address.
67 What is the proper way to allocate, copy and free a buffer?
68 After you allocate it, it is a "0 length" chunk of memory
69 starting at zero. If you want to add headers to the buffer
70 later, you'll have to call "skb_reserve(skb, amount)" with
71 the amount of memory you want reserved. Then, you call
72 "skb_put(skb, amount)" with the amount of space you want in
73 the buffer. skb_put() returns a pointer to the top (#0) of
74 that buffer. skb->len is set to the amount of space you have
75 "allocated" with skb_put(). You can then write up to skb->len
76 bytes to that buffer. If you need more, you can call skb_put()
77 again with the additional amount of space you need. You can
78 find out how much more space you can allocate by calling
80 Now, to add header space, call "skb_push(skb, header_len)".
81 This creates space at the beginning of the buffer and returns
82 a pointer to this new space. If later you need to strip a
83 header from a buffer, call "skb_pull(skb, header_len)".
84 skb_headroom() will return how much space is left at the top
85 of the buffer (before the main data). Remember, this headroom
86 space must be reserved before the skb_put() function is called.
90 This version of net/ipv4/ipip.c is cloned of net/ipv4/ip_gre.c
92 For comments look at net/ipv4/ip_gre.c --ANK
96 #include <linux/config.h>
97 #include <linux/module.h>
98 #include <linux/types.h>
99 #include <linux/sched.h>
100 #include <linux/kernel.h>
101 #include <asm/uaccess.h>
102 #include <linux/skbuff.h>
103 #include <linux/netdevice.h>
104 #include <linux/in.h>
105 #include <linux/tcp.h>
106 #include <linux/udp.h>
107 #include <linux/if_arp.h>
108 #include <linux/mroute.h>
109 #include <linux/init.h>
110 #include <linux/netfilter_ipv4.h>
112 #include <net/sock.h>
114 #include <net/icmp.h>
115 #include <net/protocol.h>
116 #include <net/ipip.h>
117 #include <net/inet_ecn.h>
118 #include <net/xfrm.h>
121 #define HASH(addr) ((addr^(addr>>4))&0xF)
123 static int ipip_fb_tunnel_init(struct net_device *dev);
124 static int ipip_tunnel_init(struct net_device *dev);
125 static void ipip_tunnel_setup(struct net_device *dev);
127 static struct net_device *ipip_fb_tunnel_dev;
129 static struct ip_tunnel *tunnels_r_l[HASH_SIZE];
130 static struct ip_tunnel *tunnels_r[HASH_SIZE];
131 static struct ip_tunnel *tunnels_l[HASH_SIZE];
132 static struct ip_tunnel *tunnels_wc[1];
133 static struct ip_tunnel **tunnels[4] = { tunnels_wc, tunnels_l, tunnels_r, tunnels_r_l };
135 static DEFINE_RWLOCK(ipip_lock);
137 static struct ip_tunnel * ipip_tunnel_lookup(u32 remote, u32 local)
139 unsigned h0 = HASH(remote);
140 unsigned h1 = HASH(local);
143 for (t = tunnels_r_l[h0^h1]; t; t = t->next) {
144 if (local == t->parms.iph.saddr &&
145 remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
148 for (t = tunnels_r[h0]; t; t = t->next) {
149 if (remote == t->parms.iph.daddr && (t->dev->flags&IFF_UP))
152 for (t = tunnels_l[h1]; t; t = t->next) {
153 if (local == t->parms.iph.saddr && (t->dev->flags&IFF_UP))
156 if ((t = tunnels_wc[0]) != NULL && (t->dev->flags&IFF_UP))
161 static struct ip_tunnel **ipip_bucket(struct ip_tunnel *t)
163 u32 remote = t->parms.iph.daddr;
164 u32 local = t->parms.iph.saddr;
176 return &tunnels[prio][h];
180 static void ipip_tunnel_unlink(struct ip_tunnel *t)
182 struct ip_tunnel **tp;
184 for (tp = ipip_bucket(t); *tp; tp = &(*tp)->next) {
186 write_lock_bh(&ipip_lock);
188 write_unlock_bh(&ipip_lock);
194 static void ipip_tunnel_link(struct ip_tunnel *t)
196 struct ip_tunnel **tp = ipip_bucket(t);
199 write_lock_bh(&ipip_lock);
201 write_unlock_bh(&ipip_lock);
204 static struct ip_tunnel * ipip_tunnel_locate(struct ip_tunnel_parm *parms, int create)
206 u32 remote = parms->iph.daddr;
207 u32 local = parms->iph.saddr;
208 struct ip_tunnel *t, **tp, *nt;
209 struct net_device *dev;
222 for (tp = &tunnels[prio][h]; (t = *tp) != NULL; tp = &t->next) {
223 if (local == t->parms.iph.saddr && remote == t->parms.iph.daddr)
230 strlcpy(name, parms->name, IFNAMSIZ);
233 for (i=1; i<100; i++) {
234 sprintf(name, "tunl%d", i);
235 if (__dev_get_by_name(name) == NULL)
242 dev = alloc_netdev(sizeof(*t), name, ipip_tunnel_setup);
247 SET_MODULE_OWNER(dev);
248 dev->init = ipip_tunnel_init;
251 if (register_netdevice(dev) < 0) {
257 ipip_tunnel_link(nt);
264 static void ipip_tunnel_uninit(struct net_device *dev)
266 if (dev == ipip_fb_tunnel_dev) {
267 write_lock_bh(&ipip_lock);
268 tunnels_wc[0] = NULL;
269 write_unlock_bh(&ipip_lock);
271 ipip_tunnel_unlink((struct ip_tunnel*)dev->priv);
275 static void ipip_err(struct sk_buff *skb, u32 info)
277 #ifndef I_WISH_WORLD_WERE_PERFECT
279 /* It is not :-( All the routers (except for Linux) return only
280 8 bytes of packet payload. It means, that precise relaying of
281 ICMP in the real Internet is absolutely infeasible.
283 struct iphdr *iph = (struct iphdr*)skb->data;
284 int type = skb->h.icmph->type;
285 int code = skb->h.icmph->code;
290 case ICMP_PARAMETERPROB:
293 case ICMP_DEST_UNREACH:
296 case ICMP_PORT_UNREACH:
297 /* Impossible event. */
299 case ICMP_FRAG_NEEDED:
300 /* Soft state for pmtu is maintained by IP core. */
303 /* All others are translated to HOST_UNREACH.
304 rfc2003 contains "deep thoughts" about NET_UNREACH,
305 I believe they are just ether pollution. --ANK
310 case ICMP_TIME_EXCEEDED:
311 if (code != ICMP_EXC_TTL)
316 read_lock(&ipip_lock);
317 t = ipip_tunnel_lookup(iph->daddr, iph->saddr);
318 if (t == NULL || t->parms.iph.daddr == 0)
320 if (t->parms.iph.ttl == 0 && type == ICMP_TIME_EXCEEDED)
323 if (jiffies - t->err_time < IPTUNNEL_ERR_TIMEO)
327 t->err_time = jiffies;
329 read_unlock(&ipip_lock);
332 struct iphdr *iph = (struct iphdr*)dp;
333 int hlen = iph->ihl<<2;
335 int type = skb->h.icmph->type;
336 int code = skb->h.icmph->code;
340 struct sk_buff *skb2;
344 if (len < hlen + sizeof(struct iphdr))
346 eiph = (struct iphdr*)(dp + hlen);
351 case ICMP_PARAMETERPROB:
352 if (skb->h.icmph->un.gateway < hlen)
355 /* So... This guy found something strange INSIDE encapsulated
356 packet. Well, he is fool, but what can we do ?
358 rel_type = ICMP_PARAMETERPROB;
359 rel_info = skb->h.icmph->un.gateway - hlen;
362 case ICMP_DEST_UNREACH:
365 case ICMP_PORT_UNREACH:
366 /* Impossible event. */
368 case ICMP_FRAG_NEEDED:
369 /* And it is the only really necessary thing :-) */
370 rel_info = ntohs(skb->h.icmph->un.frag.mtu);
371 if (rel_info < hlen+68)
374 /* BSD 4.2 MORE DOES NOT EXIST IN NATURE. */
375 if (rel_info > ntohs(eiph->tot_len))
379 /* All others are translated to HOST_UNREACH.
380 rfc2003 contains "deep thoughts" about NET_UNREACH,
381 I believe, it is just ether pollution. --ANK
383 rel_type = ICMP_DEST_UNREACH;
384 rel_code = ICMP_HOST_UNREACH;
388 case ICMP_TIME_EXCEEDED:
389 if (code != ICMP_EXC_TTL)
394 /* Prepare fake skb to feed it to icmp_send */
395 skb2 = skb_clone(skb, GFP_ATOMIC);
398 dst_release(skb2->dst);
400 skb_pull(skb2, skb->data - (u8*)eiph);
401 skb2->nh.raw = skb2->data;
403 /* Try to guess incoming interface */
404 memset(&fl, 0, sizeof(fl));
405 fl.fl4_daddr = eiph->saddr;
406 fl.fl4_tos = RT_TOS(eiph->tos);
407 fl.proto = IPPROTO_IPIP;
408 if (ip_route_output_key(&rt, &key)) {
412 skb2->dev = rt->u.dst.dev;
414 /* route "incoming" packet */
415 if (rt->rt_flags&RTCF_LOCAL) {
418 fl.fl4_daddr = eiph->daddr;
419 fl.fl4_src = eiph->saddr;
420 fl.fl4_tos = eiph->tos;
421 if (ip_route_output_key(&rt, &fl) ||
422 rt->u.dst.dev->type != ARPHRD_TUNNEL) {
429 if (ip_route_input(skb2, eiph->daddr, eiph->saddr, eiph->tos, skb2->dev) ||
430 skb2->dst->dev->type != ARPHRD_TUNNEL) {
436 /* change mtu on this route */
437 if (type == ICMP_DEST_UNREACH && code == ICMP_FRAG_NEEDED) {
438 if (rel_info > dst_mtu(skb2->dst)) {
442 skb2->dst->ops->update_pmtu(skb2->dst, rel_info);
443 rel_info = htonl(rel_info);
444 } else if (type == ICMP_TIME_EXCEEDED) {
445 struct ip_tunnel *t = (struct ip_tunnel*)skb2->dev->priv;
446 if (t->parms.iph.ttl) {
447 rel_type = ICMP_DEST_UNREACH;
448 rel_code = ICMP_HOST_UNREACH;
452 icmp_send(skb2, rel_type, rel_code, rel_info);
458 static inline void ipip_ecn_decapsulate(struct iphdr *outer_iph, struct sk_buff *skb)
460 struct iphdr *inner_iph = skb->nh.iph;
462 if (INET_ECN_is_ce(outer_iph->tos))
463 IP_ECN_set_ce(inner_iph);
466 static int ipip_rcv(struct sk_buff *skb)
469 struct ip_tunnel *tunnel;
471 if (!pskb_may_pull(skb, sizeof(struct iphdr)))
476 read_lock(&ipip_lock);
477 if ((tunnel = ipip_tunnel_lookup(iph->saddr, iph->daddr)) != NULL) {
478 if (!xfrm4_policy_check(NULL, XFRM_POLICY_IN, skb)) {
479 read_unlock(&ipip_lock);
486 skb->mac.raw = skb->nh.raw;
487 skb->nh.raw = skb->data;
488 memset(&(IPCB(skb)->opt), 0, sizeof(struct ip_options));
489 skb->protocol = htons(ETH_P_IP);
490 skb->pkt_type = PACKET_HOST;
492 tunnel->stat.rx_packets++;
493 tunnel->stat.rx_bytes += skb->len;
494 skb->dev = tunnel->dev;
495 dst_release(skb->dst);
498 ipip_ecn_decapsulate(iph, skb);
500 read_unlock(&ipip_lock);
503 read_unlock(&ipip_lock);
510 * This function assumes it is being called from dev_queue_xmit()
511 * and that skb is filled properly by that function.
514 static int ipip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev)
516 struct ip_tunnel *tunnel = (struct ip_tunnel*)dev->priv;
517 struct net_device_stats *stats = &tunnel->stat;
518 struct iphdr *tiph = &tunnel->parms.iph;
519 u8 tos = tunnel->parms.iph.tos;
520 u16 df = tiph->frag_off;
521 struct rtable *rt; /* Route to the other host */
522 struct net_device *tdev; /* Device to other host */
523 struct iphdr *old_iph = skb->nh.iph;
524 struct iphdr *iph; /* Our new IP header */
525 int max_headroom; /* The extra header space needed */
526 u32 dst = tiph->daddr;
529 if (tunnel->recursion++) {
530 tunnel->stat.collisions++;
534 if (skb->protocol != htons(ETH_P_IP))
542 if ((rt = (struct rtable*)skb->dst) == NULL) {
543 tunnel->stat.tx_fifo_errors++;
546 if ((dst = rt->rt_gateway) == 0)
551 struct flowi fl = { .oif = tunnel->parms.link,
554 .saddr = tiph->saddr,
555 .tos = RT_TOS(tos) } },
556 .proto = IPPROTO_IPIP };
557 if (ip_route_output_key(&rt, &fl)) {
558 tunnel->stat.tx_carrier_errors++;
562 tdev = rt->u.dst.dev;
566 tunnel->stat.collisions++;
571 mtu = dst_mtu(&rt->u.dst) - sizeof(struct iphdr);
573 mtu = skb->dst ? dst_mtu(skb->dst) : dev->mtu;
576 tunnel->stat.collisions++;
581 skb->dst->ops->update_pmtu(skb->dst, mtu);
583 df |= (old_iph->frag_off&htons(IP_DF));
585 if ((old_iph->frag_off&htons(IP_DF)) && mtu < ntohs(old_iph->tot_len)) {
586 icmp_send(skb, ICMP_DEST_UNREACH, ICMP_FRAG_NEEDED, htonl(mtu));
591 if (tunnel->err_count > 0) {
592 if (jiffies - tunnel->err_time < IPTUNNEL_ERR_TIMEO) {
594 dst_link_failure(skb);
596 tunnel->err_count = 0;
600 * Okay, now see if we can stuff it in the buffer as-is.
602 max_headroom = (LL_RESERVED_SPACE(tdev)+sizeof(struct iphdr));
604 if (skb_headroom(skb) < max_headroom || skb_cloned(skb) || skb_shared(skb)) {
605 struct sk_buff *new_skb = skb_realloc_headroom(skb, max_headroom);
614 skb_set_owner_w(new_skb, skb->sk);
617 old_iph = skb->nh.iph;
620 skb->h.raw = skb->nh.raw;
621 skb->nh.raw = skb_push(skb, sizeof(struct iphdr));
622 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
623 dst_release(skb->dst);
624 skb->dst = &rt->u.dst;
627 * Push down and install the IPIP header.
632 iph->ihl = sizeof(struct iphdr)>>2;
634 iph->protocol = IPPROTO_IPIP;
635 iph->tos = INET_ECN_encapsulate(tos, old_iph->tos);
636 iph->daddr = rt->rt_dst;
637 iph->saddr = rt->rt_src;
639 if ((iph->ttl = tiph->ttl) == 0)
640 iph->ttl = old_iph->ttl;
649 dst_link_failure(skb);
658 ipip_tunnel_ioctl (struct net_device *dev, struct ifreq *ifr, int cmd)
661 struct ip_tunnel_parm p;
667 if (dev == ipip_fb_tunnel_dev) {
668 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p))) {
672 t = ipip_tunnel_locate(&p, 0);
675 t = (struct ip_tunnel*)dev->priv;
676 memcpy(&p, &t->parms, sizeof(p));
677 if (copy_to_user(ifr->ifr_ifru.ifru_data, &p, sizeof(p)))
684 if (!capable(CAP_NET_ADMIN))
688 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
692 if (p.iph.version != 4 || p.iph.protocol != IPPROTO_IPIP ||
693 p.iph.ihl != 5 || (p.iph.frag_off&htons(~IP_DF)))
696 p.iph.frag_off |= htons(IP_DF);
698 t = ipip_tunnel_locate(&p, cmd == SIOCADDTUNNEL);
700 if (dev != ipip_fb_tunnel_dev && cmd == SIOCCHGTUNNEL) {
707 if (((dev->flags&IFF_POINTOPOINT) && !p.iph.daddr) ||
708 (!(dev->flags&IFF_POINTOPOINT) && p.iph.daddr)) {
712 t = (struct ip_tunnel*)dev->priv;
713 ipip_tunnel_unlink(t);
714 t->parms.iph.saddr = p.iph.saddr;
715 t->parms.iph.daddr = p.iph.daddr;
716 memcpy(dev->dev_addr, &p.iph.saddr, 4);
717 memcpy(dev->broadcast, &p.iph.daddr, 4);
719 netdev_state_change(dev);
725 if (cmd == SIOCCHGTUNNEL) {
726 t->parms.iph.ttl = p.iph.ttl;
727 t->parms.iph.tos = p.iph.tos;
728 t->parms.iph.frag_off = p.iph.frag_off;
730 if (copy_to_user(ifr->ifr_ifru.ifru_data, &t->parms, sizeof(p)))
733 err = (cmd == SIOCADDTUNNEL ? -ENOBUFS : -ENOENT);
738 if (!capable(CAP_NET_ADMIN))
741 if (dev == ipip_fb_tunnel_dev) {
743 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
746 if ((t = ipip_tunnel_locate(&p, 0)) == NULL)
749 if (t->dev == ipip_fb_tunnel_dev)
753 err = unregister_netdevice(dev);
764 static struct net_device_stats *ipip_tunnel_get_stats(struct net_device *dev)
766 return &(((struct ip_tunnel*)dev->priv)->stat);
769 static int ipip_tunnel_change_mtu(struct net_device *dev, int new_mtu)
771 if (new_mtu < 68 || new_mtu > 0xFFF8 - sizeof(struct iphdr))
777 static void ipip_tunnel_setup(struct net_device *dev)
779 SET_MODULE_OWNER(dev);
780 dev->uninit = ipip_tunnel_uninit;
781 dev->hard_start_xmit = ipip_tunnel_xmit;
782 dev->get_stats = ipip_tunnel_get_stats;
783 dev->do_ioctl = ipip_tunnel_ioctl;
784 dev->change_mtu = ipip_tunnel_change_mtu;
785 dev->destructor = free_netdev;
787 dev->type = ARPHRD_TUNNEL;
788 dev->hard_header_len = LL_MAX_HEADER + sizeof(struct iphdr);
789 dev->mtu = 1500 - sizeof(struct iphdr);
790 dev->flags = IFF_NOARP;
795 static int ipip_tunnel_init(struct net_device *dev)
797 struct net_device *tdev = NULL;
798 struct ip_tunnel *tunnel;
801 tunnel = (struct ip_tunnel*)dev->priv;
802 iph = &tunnel->parms.iph;
805 strcpy(tunnel->parms.name, dev->name);
807 memcpy(dev->dev_addr, &tunnel->parms.iph.saddr, 4);
808 memcpy(dev->broadcast, &tunnel->parms.iph.daddr, 4);
811 struct flowi fl = { .oif = tunnel->parms.link,
813 { .daddr = iph->daddr,
815 .tos = RT_TOS(iph->tos) } },
816 .proto = IPPROTO_IPIP };
818 if (!ip_route_output_key(&rt, &fl)) {
819 tdev = rt->u.dst.dev;
822 dev->flags |= IFF_POINTOPOINT;
825 if (!tdev && tunnel->parms.link)
826 tdev = __dev_get_by_index(tunnel->parms.link);
829 dev->hard_header_len = tdev->hard_header_len + sizeof(struct iphdr);
830 dev->mtu = tdev->mtu - sizeof(struct iphdr);
832 dev->iflink = tunnel->parms.link;
837 static int __init ipip_fb_tunnel_init(struct net_device *dev)
839 struct ip_tunnel *tunnel = dev->priv;
840 struct iphdr *iph = &tunnel->parms.iph;
843 strcpy(tunnel->parms.name, dev->name);
846 iph->protocol = IPPROTO_IPIP;
850 tunnels_wc[0] = tunnel;
854 #ifdef CONFIG_INET_TUNNEL
855 static struct xfrm_tunnel ipip_handler = {
857 .err_handler = ipip_err,
860 static inline int ipip_register(void)
862 return xfrm4_tunnel_register(&ipip_handler);
865 static inline int ipip_unregister(void)
867 return xfrm4_tunnel_deregister(&ipip_handler);
870 static struct net_protocol ipip_protocol = {
872 .err_handler = ipip_err,
876 static inline int ipip_register(void)
878 return inet_add_protocol(&ipip_protocol, IPPROTO_IPIP);
881 static inline int ipip_unregister(void)
883 return inet_del_protocol(&ipip_protocol, IPPROTO_IPIP);
887 static char banner[] __initdata =
888 KERN_INFO "IPv4 over IPv4 tunneling driver\n";
890 static int __init ipip_init(void)
896 if (ipip_register() < 0) {
897 printk(KERN_INFO "ipip init: can't register tunnel\n");
901 ipip_fb_tunnel_dev = alloc_netdev(sizeof(struct ip_tunnel),
904 if (!ipip_fb_tunnel_dev) {
909 ipip_fb_tunnel_dev->init = ipip_fb_tunnel_init;
911 if ((err = register_netdev(ipip_fb_tunnel_dev)))
916 free_netdev(ipip_fb_tunnel_dev);
922 static void __exit ipip_destroy_tunnels(void)
926 for (prio = 1; prio < 4; prio++) {
928 for (h = 0; h < HASH_SIZE; h++) {
930 while ((t = tunnels[prio][h]) != NULL)
931 unregister_netdevice(t->dev);
936 static void __exit ipip_fini(void)
938 if (ipip_unregister() < 0)
939 printk(KERN_INFO "ipip close: can't deregister tunnel\n");
942 ipip_destroy_tunnels();
943 unregister_netdevice(ipip_fb_tunnel_dev);
947 module_init(ipip_init);
948 module_exit(ipip_fini);
949 MODULE_LICENSE("GPL");