Several small refactorings. Split log-group of network scheduler and timer scheduler
[olsrd.git] / src / linux / kernel_tunnel.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
4  * Copyright (c) 2007, Sven-Ola for the policy routing stuff
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include "defs.h"
43 #include "olsr_types.h"
44 #include "olsr_cookie.h"
45 #include "olsr_logging.h"
46 #include "ipcalc.h"
47 #include "os_net.h"
48 #include "os_kernel_tunnel.h"
49 #include "os_kernel_routes.h"
50
51 #include <assert.h>
52
53 //ipip includes
54 #include <arpa/inet.h>
55 #include <netinet/in.h>
56 #include <sys/ioctl.h>
57 #include <net/if.h>
58 #include <linux/ip.h>
59 #include <linux/if_tunnel.h>
60 #include <linux/version.h>
61 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
62 #include <linux/ip6_tunnel.h>
63 #endif
64
65 //ifup includes
66 #include <sys/socket.h>
67 #include <sys/ioctl.h>
68 #include <sys/types.h>
69 #include <net/if.h>
70
71 static const char DEV_IPV4_TUNNEL[IFNAMSIZ] = TUNNEL_ENDPOINT_IF;
72 static const char DEV_IPV6_TUNNEL[IFNAMSIZ] = TUNNEL_ENDPOINT_IF6;
73
74 static bool store_iptunnel_state;
75 static struct olsr_cookie_info *tunnel_cookie;
76 static struct avl_tree tunnel_tree;
77
78 int os_iptunnel_init(void) {
79   const char *dev = olsr_cnf->ip_version == AF_INET ? DEV_IPV4_TUNNEL : DEV_IPV6_TUNNEL;
80
81   tunnel_cookie = olsr_create_memcookie("iptunnel", sizeof(struct olsr_iptunnel_entry));
82   avl_init(&tunnel_tree, avl_comp_default, false, NULL);
83
84   store_iptunnel_state = os_is_interface_up(dev);
85   if (store_iptunnel_state) {
86     return 0;
87   }
88   if (os_interface_set_state(dev, true)) {
89     return -1;
90   }
91
92   return olsr_os_ifip(if_nametoindex(dev), &olsr_cnf->router_id, true);
93 }
94
95 void os_iptunnel_cleanup(void) {
96   while (tunnel_tree.count > 0) {
97     struct olsr_iptunnel_entry *t;
98
99     /* kill tunnel */
100     t = avl_first_element(&tunnel_tree, t, node);
101     t->usage = 1;
102
103     os_iptunnel_del_ipip(t);
104   }
105   if (!store_iptunnel_state) {
106     os_interface_set_state(olsr_cnf->ip_version == AF_INET ? DEV_IPV4_TUNNEL : DEV_IPV6_TUNNEL, false);
107   }
108
109   olsr_cleanup_memcookie(tunnel_cookie);
110 }
111
112 /**
113  * creates an ipip tunnel (for ipv4)
114  * @param name interface name
115  * @param target pointer to tunnel target IP, NULL if tunnel should be removed
116  * @return 0 if an error happened,
117  *   if_index for successful created tunnel, 1 for successful deleted tunnel
118  */
119 static int os_ip4_tunnel(const char *name, in_addr_t *target)
120 {
121   struct ifreq ifr;
122   int err;
123   struct ip_tunnel_parm p;
124
125   /* only IPIP tunnel if OLSR runs with IPv6 */
126   assert (olsr_cnf->ip_version == AF_INET);
127   memset(&p, 0, sizeof(p));
128   p.iph.version = 4;
129   p.iph.ihl = 5;
130   p.iph.ttl = 64;
131   p.iph.protocol = IPPROTO_IPIP;
132   if (target) {
133     p.iph.daddr = *target;
134   }
135   strncpy(p.name, name, IFNAMSIZ);
136
137   memset(&ifr, 0, sizeof(ifr));
138   strncpy(ifr.ifr_name, target != NULL ? DEV_IPV4_TUNNEL : name, IFNAMSIZ);
139   ifr.ifr_ifru.ifru_data = (void *) &p;
140
141   if ((err = ioctl(olsr_cnf->ioctl_s, target != NULL ? SIOCADDTUNNEL : SIOCDELTUNNEL, &ifr))) {
142     char buffer[INET6_ADDRSTRLEN];
143
144     OLSR_WARN(LOG_TUNNEL, "Cannot %s a tunnel %s to %s: %s (%d)\n",
145         target != NULL ? "add" : "remove", name,
146         target != NULL ? inet_ntop(olsr_cnf->ip_version, target, buffer, sizeof(buffer)) : "-",
147         strerror(errno), errno);
148     return 0;
149   }
150   return target != NULL ? if_nametoindex(name) : 1;
151 }
152
153 /**
154  * creates an ipip tunnel (for ipv6)
155  * @param name interface name
156  * @param target pointer to tunnel target IP, NULL if tunnel should be removed
157  * @return 0 if an error happened,
158  *   if_index for successful created tunnel, 1 for successful deleted tunnel
159  */
160 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
161 static int os_ip6_tunnel(const char *name, struct in6_addr *target)
162 {
163   struct ifreq ifr;
164   int err;
165   struct ip6_tnl_parm p;
166
167   /* only IP6 tunnel if OLSR runs with IPv6 */
168   assert (olsr_cnf->ip_version == AF_INET6);
169   memset(&p, 0, sizeof(p));
170   p.proto = 0; /* any protocol */
171   if (target) {
172     p.raddr = *target;
173   }
174   strncpy(p.name, name, IFNAMSIZ);
175
176   memset(&ifr, 0, sizeof(ifr));
177   strncpy(ifr.ifr_name, target != NULL ? DEV_IPV6_TUNNEL : name, IFNAMSIZ);
178   ifr.ifr_ifru.ifru_data = (void *) &p;
179
180   if ((err = ioctl(olsr_cnf->ioctl_s, target != NULL ? SIOCADDTUNNEL : SIOCDELTUNNEL, &ifr))) {
181     char buffer[INET6_ADDRSTRLEN];
182
183     OLSR_WARN(LOG_TUNNEL, "Cannot %s a tunnel %s to %s: %s (%d)\n",
184         target != NULL ? "add" : "remove", name,
185         target != NULL ? inet_ntop(olsr_cnf->ip_version, target, buffer, sizeof(buffer)) : "-",
186         strerror(errno), errno);
187     return 0;
188   }
189   return target != NULL ? if_nametoindex(name) : 1;
190 }
191 #endif
192
193 /**
194  * Dummy for generating an interface name for an olsr ipip tunnel
195  * @param target IP destination of the tunnel
196  * @param name pointer to output buffer (length IFNAMSIZ)
197  */
198 static void generate_iptunnel_name(union olsr_ip_addr *target, char *name) {
199   static char PREFIX[] = "tnl_";
200   static uint32_t counter = 0;
201
202   snprintf(name, IFNAMSIZ, "%s%08x", PREFIX,
203       olsr_cnf->ip_version == AF_INET ? target->v4.s_addr : ++counter);
204 }
205
206 /**
207  * demands an ipip tunnel to a certain target. If no tunnel exists it will be created
208  * @param target ip address of the target
209  * @param transportV4 true if IPv4 traffic is used, false for IPv6 traffic
210  * @return NULL if an error happened, pointer to olsr_iptunnel_entry otherwise
211  */
212 struct olsr_iptunnel_entry *os_iptunnel_add_ipip(union olsr_ip_addr *target, bool transportV4 __attribute__ ((unused))) {
213   struct olsr_iptunnel_entry *t;
214
215   assert(olsr_cnf->ip_version == AF_INET6 || transportV4);
216
217   t = (struct olsr_iptunnel_entry *)avl_find(&tunnel_tree, target);
218   if (t == NULL) {
219     char name[IFNAMSIZ];
220     int if_idx;
221
222     memset(name, 0, sizeof(name));
223     generate_iptunnel_name(target, name);
224
225     if (olsr_cnf->ip_version == AF_INET) {
226       if_idx = os_ip4_tunnel(name, &target->v4.s_addr);
227     }
228     else {
229 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
230       if_idx = os_ip6_tunnel(name, &target->v6);
231 #else
232       if_idx = 0;
233 #endif
234     }
235
236     if (if_idx == 0) {
237       // cannot create tunnel
238       OLSR_WARN(LOG_TUNNEL, "Cannot create tunnel %s\n", name);
239       return NULL;
240     }
241
242     if (os_interface_set_state(name, true)) {
243       if (olsr_cnf->ip_version == AF_INET) {
244         os_ip4_tunnel(name, NULL);
245       }
246       else {
247   #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
248         os_ip6_tunnel(name, NULL);
249   #endif
250       }
251       return NULL;
252     }
253
254     /* set originator IP for tunnel */
255     olsr_os_ifip(if_idx, &olsr_cnf->router_id, true);
256
257     t = olsr_cookie_malloc(tunnel_cookie);
258     memcpy(&t->target, target, sizeof(*target));
259     t->node.key = &t->target;
260
261     strncpy(t->if_name, name, IFNAMSIZ);
262     t->if_index = if_idx;
263
264     avl_insert(&tunnel_tree, &t->node);
265   }
266
267   t->usage++;
268   return t;
269 }
270
271 /**
272  * Release an olsr ipip tunnel. Tunnel will be deleted
273  * if this was the last user
274  * @param t pointer to olsr_iptunnel_entry
275  */
276 static void internal_olsr_os_del_ipip_tunnel(struct olsr_iptunnel_entry *t, bool cleanup) {
277   if (!cleanup) {
278     if (t->usage == 0) {
279       return;
280     }
281     t->usage--;
282
283     if (t->usage > 0) {
284       return;
285     }
286   }
287
288   os_interface_set_state(t->if_name, false);
289   if (olsr_cnf->ip_version == AF_INET) {
290     os_ip4_tunnel(t->if_name, NULL);
291   }
292   else {
293 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
294     os_ip6_tunnel(t->if_name, NULL);
295 #endif
296   }
297
298   avl_delete(&tunnel_tree, &t->node);
299   if (!cleanup) {
300     olsr_cookie_free(tunnel_cookie, t);
301   }
302 }
303
304 void os_iptunnel_del_ipip(struct olsr_iptunnel_entry *t) {
305   internal_olsr_os_del_ipip_tunnel(t, false);
306 }