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/capability.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>
111 #include <linux/if_ether.h>
113 #include <net/sock.h>
115 #include <net/icmp.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);
246 nt = netdev_priv(dev);
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(netdev_priv(dev));
275 static int 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;
291 case ICMP_PARAMETERPROB:
294 case ICMP_DEST_UNREACH:
297 case ICMP_PORT_UNREACH:
298 /* Impossible event. */
300 case ICMP_FRAG_NEEDED:
301 /* Soft state for pmtu is maintained by IP core. */
304 /* All others are translated to HOST_UNREACH.
305 rfc2003 contains "deep thoughts" about NET_UNREACH,
306 I believe they are just ether pollution. --ANK
311 case ICMP_TIME_EXCEEDED:
312 if (code != ICMP_EXC_TTL)
319 read_lock(&ipip_lock);
320 t = ipip_tunnel_lookup(iph->daddr, iph->saddr);
321 if (t == NULL || t->parms.iph.daddr == 0)
325 if (t->parms.iph.ttl == 0 && type == ICMP_TIME_EXCEEDED)
328 if (jiffies - t->err_time < IPTUNNEL_ERR_TIMEO)
332 t->err_time = jiffies;
334 read_unlock(&ipip_lock);
337 struct iphdr *iph = (struct iphdr*)dp;
338 int hlen = iph->ihl<<2;
340 int type = skb->h.icmph->type;
341 int code = skb->h.icmph->code;
345 struct sk_buff *skb2;
349 if (len < hlen + sizeof(struct iphdr))
351 eiph = (struct iphdr*)(dp + hlen);
356 case ICMP_PARAMETERPROB:
357 if (skb->h.icmph->un.gateway < hlen)
360 /* So... This guy found something strange INSIDE encapsulated
361 packet. Well, he is fool, but what can we do ?
363 rel_type = ICMP_PARAMETERPROB;
364 rel_info = skb->h.icmph->un.gateway - hlen;
367 case ICMP_DEST_UNREACH:
370 case ICMP_PORT_UNREACH:
371 /* Impossible event. */
373 case ICMP_FRAG_NEEDED:
374 /* And it is the only really necessary thing :-) */
375 rel_info = ntohs(skb->h.icmph->un.frag.mtu);
376 if (rel_info < hlen+68)
379 /* BSD 4.2 MORE DOES NOT EXIST IN NATURE. */
380 if (rel_info > ntohs(eiph->tot_len))
384 /* All others are translated to HOST_UNREACH.
385 rfc2003 contains "deep thoughts" about NET_UNREACH,
386 I believe, it is just ether pollution. --ANK
388 rel_type = ICMP_DEST_UNREACH;
389 rel_code = ICMP_HOST_UNREACH;
393 case ICMP_TIME_EXCEEDED:
394 if (code != ICMP_EXC_TTL)
399 /* Prepare fake skb to feed it to icmp_send */
400 skb2 = skb_clone(skb, GFP_ATOMIC);
403 dst_release(skb2->dst);
405 skb_pull(skb2, skb->data - (u8*)eiph);
406 skb2->nh.raw = skb2->data;
408 /* Try to guess incoming interface */
409 memset(&fl, 0, sizeof(fl));
410 fl.fl4_daddr = eiph->saddr;
411 fl.fl4_tos = RT_TOS(eiph->tos);
412 fl.proto = IPPROTO_IPIP;
413 if (ip_route_output_key(&rt, &key)) {
417 skb2->dev = rt->u.dst.dev;
419 /* route "incoming" packet */
420 if (rt->rt_flags&RTCF_LOCAL) {
423 fl.fl4_daddr = eiph->daddr;
424 fl.fl4_src = eiph->saddr;
425 fl.fl4_tos = eiph->tos;
426 if (ip_route_output_key(&rt, &fl) ||
427 rt->u.dst.dev->type != ARPHRD_TUNNEL) {
434 if (ip_route_input(skb2, eiph->daddr, eiph->saddr, eiph->tos, skb2->dev) ||
435 skb2->dst->dev->type != ARPHRD_TUNNEL) {
441 /* change mtu on this route */
442 if (type == ICMP_DEST_UNREACH && code == ICMP_FRAG_NEEDED) {
443 if (rel_info > dst_mtu(skb2->dst)) {
447 skb2->dst->ops->update_pmtu(skb2->dst, rel_info);
448 rel_info = htonl(rel_info);
449 } else if (type == ICMP_TIME_EXCEEDED) {
450 struct ip_tunnel *t = netdev_priv(skb2->dev);
451 if (t->parms.iph.ttl) {
452 rel_type = ICMP_DEST_UNREACH;
453 rel_code = ICMP_HOST_UNREACH;
457 icmp_send(skb2, rel_type, rel_code, rel_info);
463 static inline void ipip_ecn_decapsulate(struct iphdr *outer_iph, struct sk_buff *skb)
465 struct iphdr *inner_iph = skb->nh.iph;
467 if (INET_ECN_is_ce(outer_iph->tos))
468 IP_ECN_set_ce(inner_iph);
471 static int ipip_rcv(struct sk_buff *skb)
474 struct ip_tunnel *tunnel;
478 read_lock(&ipip_lock);
479 if ((tunnel = ipip_tunnel_lookup(iph->saddr, iph->daddr)) != NULL) {
480 if (!xfrm4_policy_check(NULL, XFRM_POLICY_IN, skb)) {
481 read_unlock(&ipip_lock);
488 skb->mac.raw = skb->nh.raw;
489 skb->nh.raw = skb->data;
490 memset(&(IPCB(skb)->opt), 0, sizeof(struct ip_options));
491 skb->protocol = htons(ETH_P_IP);
492 skb->pkt_type = PACKET_HOST;
494 tunnel->stat.rx_packets++;
495 tunnel->stat.rx_bytes += skb->len;
496 skb->dev = tunnel->dev;
497 dst_release(skb->dst);
500 ipip_ecn_decapsulate(iph, skb);
502 read_unlock(&ipip_lock);
505 read_unlock(&ipip_lock);
511 * This function assumes it is being called from dev_queue_xmit()
512 * and that skb is filled properly by that function.
515 static int ipip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev)
517 struct ip_tunnel *tunnel = netdev_priv(dev);
518 struct net_device_stats *stats = &tunnel->stat;
519 struct iphdr *tiph = &tunnel->parms.iph;
520 u8 tos = tunnel->parms.iph.tos;
521 u16 df = tiph->frag_off;
522 struct rtable *rt; /* Route to the other host */
523 struct net_device *tdev; /* Device to other host */
524 struct iphdr *old_iph = skb->nh.iph;
525 struct iphdr *iph; /* Our new IP header */
526 int max_headroom; /* The extra header space needed */
527 u32 dst = tiph->daddr;
530 if (tunnel->recursion++) {
531 tunnel->stat.collisions++;
535 if (skb->protocol != htons(ETH_P_IP))
543 if ((rt = (struct rtable*)skb->dst) == NULL) {
544 tunnel->stat.tx_fifo_errors++;
547 if ((dst = rt->rt_gateway) == 0)
552 struct flowi fl = { .oif = tunnel->parms.link,
555 .saddr = tiph->saddr,
556 .tos = RT_TOS(tos) } },
557 .proto = IPPROTO_IPIP };
558 if (ip_route_output_key(&rt, &fl)) {
559 tunnel->stat.tx_carrier_errors++;
563 tdev = rt->u.dst.dev;
567 tunnel->stat.collisions++;
572 mtu = dst_mtu(&rt->u.dst) - sizeof(struct iphdr);
574 mtu = skb->dst ? dst_mtu(skb->dst) : dev->mtu;
577 tunnel->stat.collisions++;
582 skb->dst->ops->update_pmtu(skb->dst, mtu);
584 df |= (old_iph->frag_off&htons(IP_DF));
586 if ((old_iph->frag_off&htons(IP_DF)) && mtu < ntohs(old_iph->tot_len)) {
587 icmp_send(skb, ICMP_DEST_UNREACH, ICMP_FRAG_NEEDED, htonl(mtu));
592 if (tunnel->err_count > 0) {
593 if (jiffies - tunnel->err_time < IPTUNNEL_ERR_TIMEO) {
595 dst_link_failure(skb);
597 tunnel->err_count = 0;
601 * Okay, now see if we can stuff it in the buffer as-is.
603 max_headroom = (LL_RESERVED_SPACE(tdev)+sizeof(struct iphdr));
605 if (skb_headroom(skb) < max_headroom || skb_cloned(skb) || skb_shared(skb)) {
606 struct sk_buff *new_skb = skb_realloc_headroom(skb, max_headroom);
615 skb_set_owner_w(new_skb, skb->sk);
618 old_iph = skb->nh.iph;
621 skb->h.raw = skb->nh.raw;
622 skb->nh.raw = skb_push(skb, sizeof(struct iphdr));
623 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
624 IPCB(skb)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
626 dst_release(skb->dst);
627 skb->dst = &rt->u.dst;
630 * Push down and install the IPIP header.
635 iph->ihl = sizeof(struct iphdr)>>2;
637 iph->protocol = IPPROTO_IPIP;
638 iph->tos = INET_ECN_encapsulate(tos, old_iph->tos);
639 iph->daddr = rt->rt_dst;
640 iph->saddr = rt->rt_src;
642 if ((iph->ttl = tiph->ttl) == 0)
643 iph->ttl = old_iph->ttl;
652 dst_link_failure(skb);
661 ipip_tunnel_ioctl (struct net_device *dev, struct ifreq *ifr, int cmd)
664 struct ip_tunnel_parm p;
670 if (dev == ipip_fb_tunnel_dev) {
671 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p))) {
675 t = ipip_tunnel_locate(&p, 0);
678 t = netdev_priv(dev);
679 memcpy(&p, &t->parms, sizeof(p));
680 if (copy_to_user(ifr->ifr_ifru.ifru_data, &p, sizeof(p)))
687 if (!capable(CAP_NET_ADMIN))
691 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
695 if (p.iph.version != 4 || p.iph.protocol != IPPROTO_IPIP ||
696 p.iph.ihl != 5 || (p.iph.frag_off&htons(~IP_DF)))
699 p.iph.frag_off |= htons(IP_DF);
701 t = ipip_tunnel_locate(&p, cmd == SIOCADDTUNNEL);
703 if (dev != ipip_fb_tunnel_dev && cmd == SIOCCHGTUNNEL) {
710 if (((dev->flags&IFF_POINTOPOINT) && !p.iph.daddr) ||
711 (!(dev->flags&IFF_POINTOPOINT) && p.iph.daddr)) {
715 t = netdev_priv(dev);
716 ipip_tunnel_unlink(t);
717 t->parms.iph.saddr = p.iph.saddr;
718 t->parms.iph.daddr = p.iph.daddr;
719 memcpy(dev->dev_addr, &p.iph.saddr, 4);
720 memcpy(dev->broadcast, &p.iph.daddr, 4);
722 netdev_state_change(dev);
728 if (cmd == SIOCCHGTUNNEL) {
729 t->parms.iph.ttl = p.iph.ttl;
730 t->parms.iph.tos = p.iph.tos;
731 t->parms.iph.frag_off = p.iph.frag_off;
733 if (copy_to_user(ifr->ifr_ifru.ifru_data, &t->parms, sizeof(p)))
736 err = (cmd == SIOCADDTUNNEL ? -ENOBUFS : -ENOENT);
741 if (!capable(CAP_NET_ADMIN))
744 if (dev == ipip_fb_tunnel_dev) {
746 if (copy_from_user(&p, ifr->ifr_ifru.ifru_data, sizeof(p)))
749 if ((t = ipip_tunnel_locate(&p, 0)) == NULL)
752 if (t->dev == ipip_fb_tunnel_dev)
756 err = unregister_netdevice(dev);
767 static struct net_device_stats *ipip_tunnel_get_stats(struct net_device *dev)
769 return &(((struct ip_tunnel*)netdev_priv(dev))->stat);
772 static int ipip_tunnel_change_mtu(struct net_device *dev, int new_mtu)
774 if (new_mtu < 68 || new_mtu > 0xFFF8 - sizeof(struct iphdr))
780 static void ipip_tunnel_setup(struct net_device *dev)
782 SET_MODULE_OWNER(dev);
783 dev->uninit = ipip_tunnel_uninit;
784 dev->hard_start_xmit = ipip_tunnel_xmit;
785 dev->get_stats = ipip_tunnel_get_stats;
786 dev->do_ioctl = ipip_tunnel_ioctl;
787 dev->change_mtu = ipip_tunnel_change_mtu;
788 dev->destructor = free_netdev;
790 dev->type = ARPHRD_TUNNEL;
791 dev->hard_header_len = LL_MAX_HEADER + sizeof(struct iphdr);
792 dev->mtu = ETH_DATA_LEN - sizeof(struct iphdr);
793 dev->flags = IFF_NOARP;
798 static int ipip_tunnel_init(struct net_device *dev)
800 struct net_device *tdev = NULL;
801 struct ip_tunnel *tunnel;
804 tunnel = netdev_priv(dev);
805 iph = &tunnel->parms.iph;
808 strcpy(tunnel->parms.name, dev->name);
810 memcpy(dev->dev_addr, &tunnel->parms.iph.saddr, 4);
811 memcpy(dev->broadcast, &tunnel->parms.iph.daddr, 4);
814 struct flowi fl = { .oif = tunnel->parms.link,
816 { .daddr = iph->daddr,
818 .tos = RT_TOS(iph->tos) } },
819 .proto = IPPROTO_IPIP };
821 if (!ip_route_output_key(&rt, &fl)) {
822 tdev = rt->u.dst.dev;
825 dev->flags |= IFF_POINTOPOINT;
828 if (!tdev && tunnel->parms.link)
829 tdev = __dev_get_by_index(tunnel->parms.link);
832 dev->hard_header_len = tdev->hard_header_len + sizeof(struct iphdr);
833 dev->mtu = tdev->mtu - sizeof(struct iphdr);
835 dev->iflink = tunnel->parms.link;
840 static int __init ipip_fb_tunnel_init(struct net_device *dev)
842 struct ip_tunnel *tunnel = netdev_priv(dev);
843 struct iphdr *iph = &tunnel->parms.iph;
846 strcpy(tunnel->parms.name, dev->name);
849 iph->protocol = IPPROTO_IPIP;
853 tunnels_wc[0] = tunnel;
857 static struct xfrm_tunnel ipip_handler = {
859 .err_handler = ipip_err,
863 static char banner[] __initdata =
864 KERN_INFO "IPv4 over IPv4 tunneling driver\n";
866 static int __init ipip_init(void)
872 if (xfrm4_tunnel_register(&ipip_handler)) {
873 printk(KERN_INFO "ipip init: can't register tunnel\n");
877 ipip_fb_tunnel_dev = alloc_netdev(sizeof(struct ip_tunnel),
880 if (!ipip_fb_tunnel_dev) {
885 ipip_fb_tunnel_dev->init = ipip_fb_tunnel_init;
887 if ((err = register_netdev(ipip_fb_tunnel_dev)))
892 free_netdev(ipip_fb_tunnel_dev);
894 xfrm4_tunnel_deregister(&ipip_handler);
898 static void __exit ipip_destroy_tunnels(void)
902 for (prio = 1; prio < 4; prio++) {
904 for (h = 0; h < HASH_SIZE; h++) {
906 while ((t = tunnels[prio][h]) != NULL)
907 unregister_netdevice(t->dev);
912 static void __exit ipip_fini(void)
914 if (xfrm4_tunnel_deregister(&ipip_handler))
915 printk(KERN_INFO "ipip close: can't deregister tunnel\n");
918 ipip_destroy_tunnels();
919 unregister_netdevice(ipip_fb_tunnel_dev);
923 module_init(ipip_init);
924 module_exit(ipip_fini);
925 MODULE_LICENSE("GPL");