Add listener for gateway changes.
[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->hna_prefix.prefix_len == prefixlen && ipequal(&tmp->hna_prefix.prefix, 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->hna_prefix.prefix = *net;
197   new_net->hna_prefix.prefix_len= 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 (ip_is_inetgw_prefix(&net_to_delete->hna_prefix)) {
220     /* modify smart gateway entry if necessary */
221     olsr_delete_gateway_entry(&net_to_delete->hna_gw->A_gateway_addr, net_to_delete->hna_prefix.prefix_len);
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 via hna-gw %s\n",
230       olsr_ip_prefix_to_string(&net_to_delete->hna_prefix),
231               olsr_ip_to_string(&buf2, &hna_gw->A_gateway_addr));
232 #endif
233
234   /*
235    * Delete the rt_path for the entry.
236    */
237   olsr_delete_routing_table(&net_to_delete->hna_prefix.prefix,
238       net_to_delete->hna_prefix.prefix_len, &hna_gw->A_gateway_addr);
239
240   DEQUEUE_ELEM(net_to_delete);
241
242   /* Delete hna_gw if empty */
243   if (hna_gw->networks.next == &hna_gw->networks) {
244     DEQUEUE_ELEM(hna_gw);
245     olsr_cookie_free(hna_entry_mem_cookie, hna_gw);
246     removed_entry = true;
247   }
248
249   olsr_cookie_free(hna_net_mem_cookie, net_to_delete);
250   return removed_entry;
251 }
252
253 /**
254  * Callback for the hna_net timer.
255  */
256 static void
257 olsr_expire_hna_net_entry(void *context)
258 {
259   olsr_delete_hna_net_entry(context);
260 }
261
262 /**
263  * Update a HNA entry. If it does not exist it
264  * is created.
265  * This is the only function that should be called
266  * from outside concerning creation of HNA entries.
267  *
268  *@param gw address of the gateway
269  *@param net address of the network
270  *@param mask the netmask
271  *@param vtime the validitytime of the entry
272  *
273  *@return nada
274  */
275 void
276 olsr_update_hna_entry(const union olsr_ip_addr *gw, const union olsr_ip_addr *net, uint8_t prefixlen, olsr_reltime vtime)
277 {
278   struct hna_entry *gw_entry;
279   struct hna_net *net_entry;
280
281   gw_entry = olsr_lookup_hna_gw(gw);
282   if (!gw_entry) {
283
284     /* Need to add the entry */
285     gw_entry = olsr_add_hna_entry(gw);
286   }
287
288   net_entry = olsr_lookup_hna_net(&gw_entry->networks, net, prefixlen);
289   if (net_entry == NULL) {
290
291     /* Need to add the net */
292     net_entry = olsr_add_hna_net(gw_entry, net, prefixlen);
293     changes_hna = true;
294   }
295
296   /*
297    * Add the rt_path for the entry.
298    */
299   olsr_insert_routing_table(&net_entry->hna_prefix.prefix,
300       net_entry->hna_prefix.prefix_len, &gw_entry->A_gateway_addr, OLSR_RT_ORIGIN_HNA);
301
302   /*
303    * Start, or refresh the timer, whatever is appropriate.
304    */
305   olsr_set_timer(&net_entry->hna_net_timer, vtime, OLSR_HNA_NET_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_hna_net_entry, net_entry,
306                  hna_net_timer_cookie->ci_id);
307 }
308
309 /**
310  * Print all HNA entries.
311  *
312  *@return nada
313  */
314 void
315 olsr_print_hna_set(void)
316 {
317 #ifdef NODEBUG
318   /* The whole function doesn't do anything else. */
319   int idx;
320
321   OLSR_PRINTF(1, "\n--- %02d:%02d:%02d.%02d ------------------------------------------------- HNA SET\n\n", nowtm->tm_hour,
322               nowtm->tm_min, nowtm->tm_sec, (int)now.tv_usec / 10000);
323
324   if (olsr_cnf->ip_version == AF_INET)
325     OLSR_PRINTF(1, "IP net          netmask         GW IP\n");
326   else
327     OLSR_PRINTF(1, "IP net/prefixlen               GW IP\n");
328
329   for (idx = 0; idx < HASHSIZE; idx++) {
330     struct hna_entry *tmp_hna = hna_set[idx].next;
331     /* Check all entrys */
332     while (tmp_hna != &hna_set[idx]) {
333       /* Check all networks */
334       struct hna_net *tmp_net = tmp_hna->networks.next;
335
336       while (tmp_net != &tmp_hna->networks) {
337         if (olsr_cnf->ip_version == AF_INET) {
338           struct ipaddr_str buf;
339           OLSR_PRINTF(1, "%-15s ", olsr_ip_to_string(&buf, &tmp_net->A_network_addr));
340           OLSR_PRINTF(1, "%-15d ", tmp_net->prefix_len);
341           OLSR_PRINTF(1, "%-15s\n", olsr_ip_to_string(&buf, &tmp_hna->A_gateway_addr));
342         } else {
343           struct ipaddr_str buf;
344           OLSR_PRINTF(1, "%-27s/%d", olsr_ip_to_string(&buf, &tmp_net->A_network_addr), tmp_net->A_netmask.v6);
345           OLSR_PRINTF(1, "%s\n", olsr_ip_to_string(&buf, &tmp_hna->A_gateway_addr));
346         }
347
348         tmp_net = tmp_net->next;
349       }
350       tmp_hna = tmp_hna->next;
351     }
352   }
353 #endif
354 }
355
356 /**
357  *Process incoming HNA message.
358  *Forwards the message if that is to be done.
359  *
360  *@param m the incoming OLSR message
361  *the OLSR message.
362  *@return 1 on success
363  */
364
365 bool
366 olsr_input_hna(union olsr_message *m, struct interface *in_if __attribute__ ((unused)), union olsr_ip_addr *from_addr)
367 {
368
369   uint8_t olsr_msgtype;
370   olsr_reltime vtime;
371   uint16_t olsr_msgsize;
372   union olsr_ip_addr originator;
373   uint8_t hop_count;
374   uint16_t packet_seq_number;
375
376   int hnasize;
377   const uint8_t *curr, *curr_end;
378
379   struct ipaddr_str buf;
380 #ifdef DEBUG
381   OLSR_PRINTF(5, "Processing HNA\n");
382 #endif
383
384   /* Check if everyting is ok */
385   if (!m) {
386     return false;
387   }
388   curr = (const uint8_t *)m;
389
390   /* olsr_msgtype */
391   pkt_get_u8(&curr, &olsr_msgtype);
392   if (olsr_msgtype != HNA_MESSAGE) {
393     OLSR_PRINTF(1, "not a HNA message!\n");
394     return false;
395   }
396   /* Get vtime */
397   pkt_get_reltime(&curr, &vtime);
398
399   /* olsr_msgsize */
400   pkt_get_u16(&curr, &olsr_msgsize);
401
402   if (olsr_msgsize < 8 + olsr_cnf->ipsize) {
403 #ifndef WIN32
404     OLSR_PRINTF(1, "HNA message size %d too small (at least %zu)!\n", olsr_msgsize,
405                 8 + olsr_cnf->ipsize);
406 #endif
407     return false;
408   }
409
410   hnasize = olsr_msgsize - 8 - olsr_cnf->ipsize;
411   curr_end = (const uint8_t *)m + olsr_msgsize;
412
413   /* validate originator */
414   pkt_get_ipaddress(&curr, &originator);
415   /*printf("HNA from %s\n\n", olsr_ip_to_string(&buf, &originator)); */
416
417   /* ttl */
418   pkt_ignore_u8(&curr);
419
420   /* hopcnt */
421   pkt_get_u8(&curr, &hop_count);
422
423   /* seqno */
424   pkt_get_u16(&curr, &packet_seq_number);
425
426   if ((hnasize % (2 * olsr_cnf->ipsize)) != 0) {
427     OLSR_PRINTF(1, "Illegal HNA message from %s with size %d!\n",
428         olsr_ip_to_string(&buf, &originator), olsr_msgsize);
429     return false;
430   }
431
432   /*
433    *      If the sender interface (NB: not originator) of this message
434    *      is not in the symmetric 1-hop neighborhood of this node, the
435    *      message MUST be discarded.
436    */
437   if (check_neighbor_link(from_addr) != SYM_LINK) {
438     OLSR_PRINTF(2, "Received HNA from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
439     return false;
440   }
441   while (curr < curr_end) {
442     struct olsr_ip_prefix prefix;
443     union olsr_ip_addr mask;
444
445     struct ip_prefix_list *entry;
446     struct interface *ifs;
447     bool stop = false;
448
449     pkt_get_ipaddress(&curr, &prefix.prefix);
450     pkt_get_ipaddress(&curr, &mask);
451     prefix.prefix_len = olsr_netmask_to_prefix(&mask);
452
453     if (olsr_cnf->smart_gw_active && olsr_is_smart_gateway(&prefix, &mask)) {
454       olsr_update_gateway_entry(&originator, &mask, prefix.prefix_len);
455     }
456
457 #ifdef MAXIMUM_GATEWAY_PREFIX_LENGTH
458     if (olsr_cnf->smart_gw_active && prefix.prefix_len > 0 && prefix.prefix_len <= MAXIMUM_GATEWAY_PREFIX_LENGTH) {
459       continue;
460     }
461 #endif
462
463 #ifndef NO_DUPLICATE_DETECTION_HANDLER
464     for (ifs = ifnet; ifs != NULL; ifs = ifs->int_next) {
465       if (ipequal(&ifs->ip_addr, &prefix.prefix)) {
466       /* ignore your own main IP as an incoming MID */
467         olsr_handle_hna_collision(&prefix.prefix, &originator);
468         stop = true;
469         break;
470       }
471     }
472     if (stop) {
473       continue;
474     }
475 #endif
476     entry = ip_prefix_list_find(olsr_cnf->hna_entries, &prefix.prefix, prefix.prefix_len);
477     if (entry == NULL) {
478       /* only update if it's not from us */
479       olsr_update_hna_entry(&originator, &prefix.prefix, prefix.prefix_len, vtime);
480     }
481   }
482   /* Forward the message */
483   return true;
484 }
485
486 /*
487  * Local Variables:
488  * c-basic-offset: 2
489  * indent-tabs-mode: nil
490  * End:
491  */