Merge branch 'stable' into tunnel
[olsrd.git] / src / hna_set.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
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 "ipcalc.h"
43 #include "defs.h"
44 #include "olsr.h"
45 #include "scheduler.h"
46 #include "net_olsr.h"
47 #include "tc_set.h"
48 #include "parser.h"
49 #include "gateway.h"
50 #include "duplicate_handler.h"
51
52 struct hna_entry hna_set[HASHSIZE];
53 struct olsr_cookie_info *hna_net_timer_cookie = NULL;
54 struct olsr_cookie_info *hna_entry_mem_cookie = NULL;
55 struct olsr_cookie_info *hna_net_mem_cookie = NULL;
56
57 static bool olsr_delete_hna_net_entry(struct hna_net *net_to_delete);
58
59 /**
60  * Initialize the HNA set
61  */
62 int
63 olsr_init_hna_set(void)
64 {
65   int idx;
66
67   for (idx = 0; idx < HASHSIZE; idx++) {
68     hna_set[idx].next = &hna_set[idx];
69     hna_set[idx].prev = &hna_set[idx];
70   }
71
72   hna_net_timer_cookie = olsr_alloc_cookie("HNA Network", OLSR_COOKIE_TYPE_TIMER);
73
74   hna_net_mem_cookie = olsr_alloc_cookie("hna_net", OLSR_COOKIE_TYPE_MEMORY);
75   olsr_cookie_set_memory_size(hna_net_mem_cookie, sizeof(struct hna_net));
76
77   hna_entry_mem_cookie = olsr_alloc_cookie("hna_entry", OLSR_COOKIE_TYPE_MEMORY);
78   olsr_cookie_set_memory_size(hna_entry_mem_cookie, sizeof(struct hna_entry));
79
80   return 1;
81 }
82
83 void
84 olsr_cleanup_hna(union olsr_ip_addr *orig) {
85   struct hna_entry *hna;
86
87   OLSR_FOR_ALL_HNA_ENTRIES(hna) {
88     if (hna->networks.next != &hna->networks && ipequal(&hna->A_gateway_addr, orig)) {
89       while (!olsr_delete_hna_net_entry(hna->networks.next));
90     }
91   } OLSR_FOR_ALL_HNA_ENTRIES_END(hna)
92 }
93
94 /**
95  * Lookup a network entry in a networkentry list.
96  *
97  * @param nets the network list to look in
98  * @param net the network to look for
99  * @param mask the netmask to look for
100  *
101  * @return the localized entry or NULL of not found
102  */
103 struct hna_net *
104 olsr_lookup_hna_net(const struct hna_net *nets, const union olsr_ip_addr *net, uint8_t prefixlen)
105 {
106   struct hna_net *tmp;
107
108   /* Loop trough entrys */
109   for (tmp = nets->next; tmp != nets; tmp = tmp->next) {
110     if (tmp->prefixlen == prefixlen && ipequal(&tmp->A_network_addr, net)) {
111       return tmp;
112     }
113   }
114
115   /* Not found */
116   return NULL;
117 }
118
119 /**
120  * Lookup a gateway entry
121  *
122  * @param gw the address of the gateway
123  * @return the located entry or NULL if not found
124  */
125 struct hna_entry *
126 olsr_lookup_hna_gw(const union olsr_ip_addr *gw)
127 {
128   struct hna_entry *tmp_hna;
129   uint32_t hash = olsr_ip_hashing(gw);
130
131 #if 0
132   OLSR_PRINTF(5, "HNA: lookup entry\n");
133 #endif
134   /* Check for registered entry */
135
136   for (tmp_hna = hna_set[hash].next; tmp_hna != &hna_set[hash]; tmp_hna = tmp_hna->next) {
137     if (ipequal(&tmp_hna->A_gateway_addr, gw)) {
138       return tmp_hna;
139     }
140   }
141
142   /* Not found */
143   return NULL;
144 }
145
146 /**
147  *Add a gatewayentry to the HNA set
148  *
149  *@param addr the address of the gateway
150  *
151  *@return the created entry
152  */
153 struct hna_entry *
154 olsr_add_hna_entry(const union olsr_ip_addr *addr)
155 {
156   struct hna_entry *new_entry;
157   uint32_t hash;
158
159   new_entry = olsr_cookie_malloc(hna_entry_mem_cookie);
160
161   /* Fill struct */
162   new_entry->A_gateway_addr = *addr;
163
164   /* Link nets */
165   new_entry->networks.next = &new_entry->networks;
166   new_entry->networks.prev = &new_entry->networks;
167
168   /* queue */
169   hash = olsr_ip_hashing(addr);
170
171   hna_set[hash].next->prev = new_entry;
172   new_entry->next = hna_set[hash].next;
173   hna_set[hash].next = new_entry;
174   new_entry->prev = &hna_set[hash];
175
176   return new_entry;
177 }
178
179 /**
180  * Adds a network entry to a HNA gateway.
181  *
182  * @param hna_gw the gateway entry to add the network to
183  * @param net the networkaddress to add
184  * @param mask the netmask
185  *
186  * @return the newly created entry
187  */
188 struct hna_net *
189 olsr_add_hna_net(struct hna_entry *hna_gw, const union olsr_ip_addr *net, uint8_t prefixlen)
190 {
191   /* Add the net */
192   struct hna_net *new_net = olsr_cookie_malloc(hna_net_mem_cookie);
193
194   /* Fill struct */
195   memset(new_net, 0, sizeof(struct hna_net));
196   new_net->A_network_addr = *net;
197   new_net->prefixlen = prefixlen;
198
199   /* Set backpointer */
200   new_net->hna_gw = hna_gw;
201
202   /* Queue */
203   hna_gw->networks.next->prev = new_net;
204   new_net->next = hna_gw->networks.next;
205   hna_gw->networks.next = new_net;
206   new_net->prev = &hna_gw->networks;
207
208   return new_net;
209 }
210
211 static bool
212 olsr_delete_hna_net_entry(struct hna_net *net_to_delete) {
213 #ifdef DEBUG
214   struct ipaddr_str buf1, buf2;
215 #endif
216   struct hna_entry *hna_gw;
217   bool removed_entry = false;
218
219   if (net_to_delete->prefixlen == 0) {
220     /* remove gateway if HNA 0/0 is removed */
221     olsr_delete_gateway(&net_to_delete->hna_gw->A_gateway_addr);
222   }
223
224   olsr_stop_timer(net_to_delete->hna_net_timer);
225   net_to_delete->hna_net_timer = NULL;  /* be pedandic */
226   hna_gw = net_to_delete->hna_gw;
227
228 #ifdef DEBUG
229   OLSR_PRINTF(5, "HNA: timeout %s/%u via hna-gw %s\n", olsr_ip_to_string(&buf1, &net_to_delete->A_network_addr),
230               net_to_delete->prefixlen, olsr_ip_to_string(&buf2, &hna_gw->A_gateway_addr));
231 #endif
232
233   /*
234    * Delete the rt_path for the entry.
235    */
236   olsr_delete_routing_table(&net_to_delete->A_network_addr, net_to_delete->prefixlen, &hna_gw->A_gateway_addr);
237
238   DEQUEUE_ELEM(net_to_delete);
239
240   /* Delete hna_gw if empty */
241   if (hna_gw->networks.next == &hna_gw->networks) {
242     DEQUEUE_ELEM(hna_gw);
243     olsr_cookie_free(hna_entry_mem_cookie, hna_gw);
244     removed_entry = true;
245   }
246
247   olsr_cookie_free(hna_net_mem_cookie, net_to_delete);
248   return removed_entry;
249 }
250
251 /**
252  * Callback for the hna_net timer.
253  */
254 static void
255 olsr_expire_hna_net_entry(void *context)
256 {
257   olsr_delete_hna_net_entry(context);
258 }
259
260 /**
261  * Update a HNA entry. If it does not exist it
262  * is created.
263  * This is the only function that should be called
264  * from outside concerning creation of HNA entries.
265  *
266  *@param gw address of the gateway
267  *@param net address of the network
268  *@param mask the netmask
269  *@param vtime the validitytime of the entry
270  *
271  *@return nada
272  */
273 void
274 olsr_update_hna_entry(const union olsr_ip_addr *gw, const union olsr_ip_addr *net, uint8_t prefixlen, olsr_reltime vtime)
275 {
276   struct hna_entry *gw_entry;
277   struct hna_net *net_entry;
278
279   gw_entry = olsr_lookup_hna_gw(gw);
280   if (!gw_entry) {
281
282     /* Need to add the entry */
283     gw_entry = olsr_add_hna_entry(gw);
284   }
285
286   net_entry = olsr_lookup_hna_net(&gw_entry->networks, net, prefixlen);
287   if (net_entry == NULL) {
288
289     /* Need to add the net */
290     net_entry = olsr_add_hna_net(gw_entry, net, prefixlen);
291     changes_hna = true;
292   }
293
294   /*
295    * Add the rt_path for the entry.
296    */
297   olsr_insert_routing_table(&net_entry->A_network_addr, net_entry->prefixlen, &gw_entry->A_gateway_addr, OLSR_RT_ORIGIN_HNA);
298
299   /*
300    * Start, or refresh the timer, whatever is appropriate.
301    */
302   olsr_set_timer(&net_entry->hna_net_timer, vtime, OLSR_HNA_NET_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_hna_net_entry, net_entry,
303                  hna_net_timer_cookie->ci_id);
304 }
305
306 /**
307  * Print all HNA entries.
308  *
309  *@return nada
310  */
311 void
312 olsr_print_hna_set(void)
313 {
314 #ifdef NODEBUG
315   /* The whole function doesn't do anything else. */
316   int idx;
317
318   OLSR_PRINTF(1, "\n--- %02d:%02d:%02d.%02d ------------------------------------------------- HNA SET\n\n", nowtm->tm_hour,
319               nowtm->tm_min, nowtm->tm_sec, (int)now.tv_usec / 10000);
320
321   if (olsr_cnf->ip_version == AF_INET)
322     OLSR_PRINTF(1, "IP net          netmask         GW IP\n");
323   else
324     OLSR_PRINTF(1, "IP net/prefixlen               GW IP\n");
325
326   for (idx = 0; idx < HASHSIZE; idx++) {
327     struct hna_entry *tmp_hna = hna_set[idx].next;
328     /* Check all entrys */
329     while (tmp_hna != &hna_set[idx]) {
330       /* Check all networks */
331       struct hna_net *tmp_net = tmp_hna->networks.next;
332
333       while (tmp_net != &tmp_hna->networks) {
334         if (olsr_cnf->ip_version == AF_INET) {
335           struct ipaddr_str buf;
336           OLSR_PRINTF(1, "%-15s ", olsr_ip_to_string(&buf, &tmp_net->A_network_addr));
337           OLSR_PRINTF(1, "%-15d ", tmp_net->prefix_len);
338           OLSR_PRINTF(1, "%-15s\n", olsr_ip_to_string(&buf, &tmp_hna->A_gateway_addr));
339         } else {
340           struct ipaddr_str buf;
341           OLSR_PRINTF(1, "%-27s/%d", olsr_ip_to_string(&buf, &tmp_net->A_network_addr), tmp_net->A_netmask.v6);
342           OLSR_PRINTF(1, "%s\n", olsr_ip_to_string(&buf, &tmp_hna->A_gateway_addr));
343         }
344
345         tmp_net = tmp_net->next;
346       }
347       tmp_hna = tmp_hna->next;
348     }
349   }
350 #endif
351 }
352
353 /**
354  *Process incoming HNA message.
355  *Forwards the message if that is to be done.
356  *
357  *@param m the incoming OLSR message
358  *the OLSR message.
359  *@return 1 on success
360  */
361
362 bool
363 olsr_input_hna(union olsr_message *m, struct interface *in_if __attribute__ ((unused)), union olsr_ip_addr *from_addr)
364 {
365
366   uint8_t olsr_msgtype;
367   olsr_reltime vtime;
368   uint16_t olsr_msgsize;
369   union olsr_ip_addr originator;
370   uint8_t hop_count;
371   uint16_t packet_seq_number;
372
373   int hnasize;
374   const uint8_t *curr, *curr_end;
375
376   struct ipaddr_str buf;
377 #ifdef DEBUG
378   OLSR_PRINTF(5, "Processing HNA\n");
379 #endif
380
381   /* Check if everyting is ok */
382   if (!m) {
383     return false;
384   }
385   curr = (const uint8_t *)m;
386
387   /* olsr_msgtype */
388   pkt_get_u8(&curr, &olsr_msgtype);
389   if (olsr_msgtype != HNA_MESSAGE) {
390     OLSR_PRINTF(1, "not a HNA message!\n");
391     return false;
392   }
393   /* Get vtime */
394   pkt_get_reltime(&curr, &vtime);
395
396   /* olsr_msgsize */
397   pkt_get_u16(&curr, &olsr_msgsize);
398
399   if (olsr_msgsize < 8 + olsr_cnf->ipsize) {
400 #ifndef WIN32
401     OLSR_PRINTF(1, "HNA message size %d too small (at least %zu)!\n", olsr_msgsize,
402                 8 + olsr_cnf->ipsize);
403 #endif
404     return false;
405   }
406
407   hnasize = olsr_msgsize - 8 - olsr_cnf->ipsize;
408   curr_end = (const uint8_t *)m + olsr_msgsize;
409
410   /* validate originator */
411   pkt_get_ipaddress(&curr, &originator);
412   /*printf("HNA from %s\n\n", olsr_ip_to_string(&buf, &originator)); */
413
414   /* ttl */
415   pkt_ignore_u8(&curr);
416
417   /* hopcnt */
418   pkt_get_u8(&curr, &hop_count);
419
420   /* seqno */
421   pkt_get_u16(&curr, &packet_seq_number);
422
423   if ((hnasize % (2 * olsr_cnf->ipsize)) != 0) {
424     OLSR_PRINTF(1, "Illegal HNA message from %s with size %d!\n",
425         olsr_ip_to_string(&buf, &originator), olsr_msgsize);
426     return false;
427   }
428
429   /*
430    *      If the sender interface (NB: not originator) of this message
431    *      is not in the symmetric 1-hop neighborhood of this node, the
432    *      message MUST be discarded.
433    */
434   if (check_neighbor_link(from_addr) != SYM_LINK) {
435     OLSR_PRINTF(2, "Received HNA from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
436     return false;
437   }
438   while (curr < curr_end) {
439     union olsr_ip_addr net, mask;
440     uint8_t prefixlen;
441     struct ip_prefix_list *entry;
442     struct interface *ifs;
443     bool stop = false;
444
445     pkt_get_ipaddress(&curr, &net);
446     pkt_get_ipaddress(&curr, &mask);
447     if (olsr_cnf->smart_gateway_active && olsr_is_smart_gateway(&net, &mask)) {
448       olsr_set_gateway(&originator, &mask);
449     }
450
451     prefixlen = olsr_netmask_to_prefix(&mask);
452     if (olsr_cnf->smart_gateway_active && prefixlen > 0 && prefixlen <= MAXIMUM_GATEWAY_PREFIX_LENGTH) {
453       continue;
454     }
455
456 #ifndef NO_DUPLICATE_DETECTION_HANDLER
457     for (ifs = ifnet; ifs != NULL; ifs = ifs->int_next) {
458       if (ipequal(&ifs->ip_addr, &net)) {
459       /* ignore your own main IP as an incoming MID */
460         olsr_handle_hna_collision(&net, &originator);
461         stop = true;
462         break;
463       }
464     }
465     if (stop) {
466       continue;
467     }
468 #endif
469     entry = ip_prefix_list_find(olsr_cnf->hna_entries, &net, prefixlen);
470     if (entry == NULL) {
471       /* only update if it's not from us */
472       olsr_update_hna_entry(&originator, &net, prefixlen, vtime);
473     }
474   }
475   /* Forward the message */
476   return true;
477 }
478
479 /*
480  * Local Variables:
481  * c-basic-offset: 2
482  * indent-tabs-mode: nil
483  * End:
484  */