FIX: hanging topology edges if neighbor is lost
[olsrd.git] / src / tc_set.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
5  * LSDB rewrite (c) 2007, Hannes Gredler (hannes@gredler.at)
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in
16  *   the documentation and/or other materials provided with the
17  *   distribution.
18  * * Neither the name of olsr.org, olsrd nor the names of its
19  *   contributors may be used to endorse or promote products derived
20  *   from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * Visit http://www.olsr.org for more information.
36  *
37  * If you find this software useful feel free to make a donation
38  * to the project. For more information see the website or contact
39  * the copyright holders.
40  *
41  */
42
43 #include "tc_set.h"
44 #include "ipcalc.h"
45 #include "mid_set.h"
46 #include "link_set.h"
47 #include "olsr.h"
48 #include "scheduler.h"
49 #include "olsr_spf.h"
50 #include "common/avl.h"
51 #include "lq_packet.h"
52 #include "net_olsr.h"
53 #include "lq_plugin.h"
54 #include "olsr_cookie.h"
55
56 #include <assert.h>
57
58 /* Root of the link state database */
59 struct avl_tree tc_tree;
60 struct tc_entry *tc_myself;            /* Shortcut to ourselves */
61
62 /* Some cookies for stats keeping */
63 struct olsr_cookie_info *tc_edge_gc_timer_cookie = NULL;
64 struct olsr_cookie_info *tc_validity_timer_cookie = NULL;
65 struct olsr_cookie_info *tc_edge_mem_cookie = NULL;
66 struct olsr_cookie_info *tc_mem_cookie = NULL;
67
68 /*
69  * Sven-Ola 2007-Dec: These four constants include an assumption
70  * on how long a typical olsrd mesh memorizes (TC) messages in the
71  * RAM of all nodes and how many neighbour changes between TC msgs.
72  * In Berlin, we encounter hop values up to 70 which means that
73  * messages may live up to ~15 minutes cycling between nodes and
74  * obviously breaking out of the timeout_dup() jail. It may be more
75  * correct to dynamically adapt those constants, e.g. by using the
76  * max hop number (denotes size-of-mesh) in some form or maybe
77  * a factor indicating how many (old) versions of olsrd are on.
78  */
79
80 /* Value window for ansn, identifies old messages to be ignored */
81 #define TC_ANSN_WINDOW 256
82
83 /* Value window for seqno, identifies old messages to be ignored */
84 #define TC_SEQNO_WINDOW 1024
85
86 /* Enlarges the value window for upcoming ansn/seqno to be accepted */
87 #define TC_ANSN_WINDOW_MULT 4
88
89 /* Enlarges the value window for upcoming ansn/seqno to be accepted */
90 #define TC_SEQNO_WINDOW_MULT 8
91
92 static bool
93 olsr_seq_inrange_low(int beg, int end, uint16_t seq)
94 {
95   if (beg < 0) {
96     if (seq >= (uint16_t) beg || seq < end) {
97       return true;
98     }
99   } else if (end >= 0x10000) {
100     if (seq >= beg || seq < (uint16_t) end) {
101       return true;
102     }
103   } else if (seq >= beg && seq < end) {
104     return true;
105   }
106   return false;
107 }
108
109 static bool
110 olsr_seq_inrange_high(int beg, int end, uint16_t seq)
111 {
112   if (beg < 0) {
113     if (seq > (uint16_t) beg || seq <= end) {
114       return true;
115     }
116   } else if (end >= 0x10000) {
117     if (seq > beg || seq <= (uint16_t) end) {
118       return true;
119     }
120   } else if (seq > beg && seq <= end) {
121     return true;
122   }
123   return false;
124 }
125
126 /**
127  * Add a new tc_entry to the tc tree
128  *
129  * @param (last)adr address of the entry
130  * @return a pointer to the created entry
131  */
132 static struct tc_entry *
133 olsr_add_tc_entry(union olsr_ip_addr *adr)
134 {
135 #ifdef DEBUG
136   struct ipaddr_str buf;
137 #endif
138   struct tc_entry *tc;
139
140   /*
141    * Safety net against loss of the last main IP address.
142    */
143   if (ipequal(&olsr_cnf->main_addr, &all_zero)) {
144     return NULL;
145   }
146 #ifdef DEBUG
147   OLSR_PRINTF(1, "TC: add entry %s\n", olsr_ip_to_string(&buf, adr));
148 #endif
149
150   tc = olsr_cookie_malloc(tc_mem_cookie);
151   if (!tc) {
152     return NULL;
153   }
154
155   /* Fill entry */
156   tc->addr = *adr;
157   tc->vertex_node.key = &tc->addr;
158
159   /*
160    * Insert into the global tc tree.
161    */
162   avl_insert(&tc_tree, &tc->vertex_node, AVL_DUP_NO);
163   olsr_lock_tc_entry(tc);
164
165   /*
166    * Initialize subtrees for edges and prefixes.
167    */
168   avl_init(&tc->edge_tree, avl_comp_default);
169   avl_init(&tc->prefix_tree, avl_comp_prefix_default);
170
171   /*
172    * Add a rt_path for ourselves.
173    */
174   olsr_insert_routing_table(adr, olsr_cnf->maxplen, adr, OLSR_RT_ORIGIN_INT);
175
176   return tc;
177 }
178
179 /**
180  * Initialize the topology set
181  *
182  */
183 void
184 olsr_init_tc(void)
185 {
186   OLSR_PRINTF(5, "TC: init topo\n");
187
188   avl_init(&tc_tree, avl_comp_default);
189
190   /*
191    * Get some cookies for getting stats to ease troubleshooting.
192    */
193   tc_edge_gc_timer_cookie = olsr_alloc_cookie("TC edge GC", OLSR_COOKIE_TYPE_TIMER);
194   tc_validity_timer_cookie = olsr_alloc_cookie("TC validity", OLSR_COOKIE_TYPE_TIMER);
195
196   tc_edge_mem_cookie = olsr_alloc_cookie("tc_edge_entry", OLSR_COOKIE_TYPE_MEMORY);
197   olsr_cookie_set_memory_size(tc_edge_mem_cookie, sizeof(struct tc_edge_entry) + active_lq_handler->tc_lq_size);
198
199   tc_mem_cookie = olsr_alloc_cookie("tc_entry", OLSR_COOKIE_TYPE_MEMORY);
200   olsr_cookie_set_memory_size(tc_mem_cookie, sizeof(struct tc_entry));
201
202   /*
203    * Add a TC entry for ourselves.
204    */
205   tc_myself = olsr_add_tc_entry(&olsr_cnf->main_addr);
206 }
207
208 /**
209  * The main ip address has changed.
210  * Do the needful.
211  */
212 void
213 olsr_change_myself_tc(void)
214 {
215   if (tc_myself) {
216
217     /*
218      * Check if there was a change.
219      */
220     if (ipequal(&tc_myself->addr, &olsr_cnf->main_addr)) {
221       return;
222     }
223
224     /*
225      * Flush our own tc_entry.
226      */
227     olsr_delete_tc_entry(tc_myself);
228   }
229
230   /*
231    * The old entry for ourselves is gone, generate a new one and trigger SPF.
232    */
233   tc_myself = olsr_add_tc_entry(&olsr_cnf->main_addr);
234   changes_topology = true;
235 }
236
237 /*
238  * Increment the reference counter.
239  */
240 void
241 olsr_lock_tc_entry(struct tc_entry *tc)
242 {
243   tc->refcount++;
244 }
245
246 /*
247  * Unlock and free a tc_entry once all references are gone.
248  */
249 void
250 olsr_unlock_tc_entry(struct tc_entry *tc)
251 {
252   if (--tc->refcount) {
253     return;
254   }
255
256   /*
257    * All references are gone.
258    */
259   olsr_cookie_free(tc_mem_cookie, tc);
260 }
261
262 /**
263  * Delete a TC entry.
264  *
265  * @param entry the TC entry to delete
266  *
267  */
268 void
269 olsr_delete_tc_entry(struct tc_entry *tc)
270 {
271   struct tc_edge_entry *tc_edge;
272   struct rt_path *rtp;
273 #if 0
274   struct ipaddr_str buf;
275   OLSR_PRINTF(1, "TC: del entry %s\n", olsr_ip_to_string(&buf, &tc->addr));
276 #endif
277
278   /*
279    * Delete the rt_path for ourselves.
280    */
281   olsr_delete_routing_table(&tc->addr, olsr_cnf->maxplen, &tc->addr);
282
283   /* The edgetree and prefix tree must be empty before */
284   OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
285     olsr_delete_tc_edge_entry(tc_edge);
286   } OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
287
288   OLSR_FOR_ALL_PREFIX_ENTRIES(tc, rtp) {
289     olsr_delete_rt_path(rtp);
290   } OLSR_FOR_ALL_PREFIX_ENTRIES_END(tc, rtp);
291
292   /* Stop running timers */
293   olsr_stop_timer(tc->edge_gc_timer);
294   tc->edge_gc_timer = NULL;
295   olsr_stop_timer(tc->validity_timer);
296   tc->validity_timer = NULL;
297
298   avl_delete(&tc_tree, &tc->vertex_node);
299   olsr_unlock_tc_entry(tc);
300 }
301
302 /**
303  * Look up a entry from the TC tree based on address
304  *
305  * @param adr the address to look for
306  * @return the entry found or NULL
307  */
308 struct tc_entry *
309 olsr_lookup_tc_entry(union olsr_ip_addr *adr)
310 {
311   struct avl_node *node;
312
313 #if 0
314   OLSR_PRINTF(1, "TC: lookup entry\n");
315 #endif
316
317   node = avl_find(&tc_tree, adr);
318
319   return (node ? vertex_tree2tc(node) : NULL);
320 }
321
322 /*
323  * Lookup a tc entry. Creates one if it does not exist yet.
324  */
325 struct tc_entry *
326 olsr_locate_tc_entry(union olsr_ip_addr *adr)
327 {
328   struct tc_entry *tc;
329
330   if (!(tc = olsr_lookup_tc_entry(adr))) {
331     return olsr_add_tc_entry(adr);
332   }
333   return tc;
334 }
335
336 /**
337  * Format tc_edge contents into a buffer.
338  */
339 char *
340 olsr_tc_edge_to_string(struct tc_edge_entry *tc_edge)
341 {
342   static char buf[128];
343   struct ipaddr_str addrbuf, dstbuf;
344   struct tc_entry *tc = tc_edge->tc;
345   struct lqtextbuffer lqbuffer1, lqbuffer2;
346
347   snprintf(buf, sizeof(buf), "%s > %s, cost (%6s) %s", olsr_ip_to_string(&addrbuf, &tc->addr),
348            olsr_ip_to_string(&dstbuf, &tc_edge->T_dest_addr), get_tc_edge_entry_text(tc_edge, '/', &lqbuffer1),
349            get_linkcost_text(tc_edge->cost, false, &lqbuffer2));
350
351   return buf;
352 }
353
354 /**
355  * Wrapper for the timer callback.
356  * A TC entry has not been refreshed in time.
357  * Remove it from the link-state database.
358  */
359 static void
360 olsr_expire_tc_entry(void *context)
361 {
362   struct tc_entry *tc;
363
364   tc = (struct tc_entry *)context;
365   tc->validity_timer = NULL;
366
367   olsr_delete_tc_entry(tc);
368   changes_topology = true;
369 }
370
371 /**
372  * Wrapper for the timer callback.
373  * Does the garbage collection of older ansn entries after no edge addition to
374  * the TC entry has happened for OLSR_TC_EDGE_GC_TIME.
375  */
376 static void
377 olsr_expire_tc_edge_gc(void *context)
378 {
379   struct tc_entry *tc;
380
381   tc = (struct tc_entry *)context;
382   tc->edge_gc_timer = NULL;
383
384   if (olsr_delete_outdated_tc_edges(tc)) {
385     changes_topology = true;
386   }
387 }
388
389 /*
390  * If the edge does not have a minimum acceptable link quality
391  * set the etx cost to infinity such that it gets ignored during
392  * SPF calculation.
393  *
394  * @return 1 if the change of the etx value was relevant
395  */
396 bool
397 olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *tc_edge)
398 {
399   olsr_linkcost old;
400
401   /*
402    * Some sanity check before recalculating the etx.
403    */
404   if (olsr_cnf->lq_level < 1) {
405     return 0;
406   }
407
408   old = tc_edge->cost;
409   tc_edge->cost = olsr_calc_tc_cost(tc_edge);
410
411   return olsr_is_relevant_costchange(old, tc_edge->cost);
412 }
413
414 /**
415  * Add a new tc_edge_entry to the tc_edge_tree
416  *
417  * @param (last)adr address of the entry
418  * @return a pointer to the created entry
419  */
420 struct tc_edge_entry *
421 olsr_add_tc_edge_entry(struct tc_entry *tc, union olsr_ip_addr *addr, uint16_t ansn)
422 {
423 #ifdef DEBUG
424   struct ipaddr_str buf;
425 #endif
426   struct tc_entry *tc_neighbor;
427   struct tc_edge_entry *tc_edge, *tc_edge_inv;
428
429   tc_edge = olsr_cookie_malloc(tc_edge_mem_cookie);
430   if (!tc_edge) {
431     return NULL;
432   }
433
434   /* Fill entry */
435   tc_edge->T_dest_addr = *addr;
436   tc_edge->ansn = ansn;
437   tc_edge->edge_node.key = &tc_edge->T_dest_addr;
438
439   /*
440    * Insert into the edge tree.
441    */
442   avl_insert(&tc->edge_tree, &tc_edge->edge_node, AVL_DUP_NO);
443   olsr_lock_tc_entry(tc);
444
445   /*
446    * Connect backpointer.
447    */
448   tc_edge->tc = tc;
449
450   /*
451    * Check if the neighboring router and the inverse edge is in the lsdb.
452    * Create short cuts to the inverse edge for faster SPF execution.
453    */
454   tc_neighbor = olsr_lookup_tc_entry(&tc_edge->T_dest_addr);
455   if (tc_neighbor) {
456 #ifdef DEBUG
457     OLSR_PRINTF(1, "TC:   found neighbor tc_entry %s\n", olsr_ip_to_string(&buf, &tc_neighbor->addr));
458 #endif
459
460     tc_edge_inv = olsr_lookup_tc_edge(tc_neighbor, &tc->addr);
461     if (tc_edge_inv) {
462 #ifdef DEBUG
463       OLSR_PRINTF(1, "TC:   found inverse edge for %s\n", olsr_ip_to_string(&buf, &tc_edge_inv->T_dest_addr));
464 #endif
465
466       /*
467        * Connect the edges mutually.
468        */
469       tc_edge_inv->edge_inv = tc_edge;
470       tc_edge->edge_inv = tc_edge_inv;
471
472     }
473   }
474
475   /*
476    * Update the etx.
477    */
478   olsr_calc_tc_edge_entry_etx(tc_edge);
479
480 #ifdef DEBUG
481   OLSR_PRINTF(1, "TC: add edge entry %s\n", olsr_tc_edge_to_string(tc_edge));
482 #endif
483
484   return tc_edge;
485 }
486
487 /**
488  * Delete a TC edge entry.
489  *
490  * @param tc the TC entry
491  * @param tc_edge the TC edge entry
492  */
493 void
494 olsr_delete_tc_edge_entry(struct tc_edge_entry *tc_edge)
495 {
496   struct tc_entry *tc;
497   struct tc_edge_entry *tc_edge_inv;
498
499 #ifdef DEBUG
500   OLSR_PRINTF(1, "TC: del edge entry %s\n", olsr_tc_edge_to_string(tc_edge));
501 #endif
502
503   tc = tc_edge->tc;
504   avl_delete(&tc->edge_tree, &tc_edge->edge_node);
505   olsr_unlock_tc_entry(tc);
506
507   /*
508    * Clear the backpointer of our inverse edge.
509    */
510   tc_edge_inv = tc_edge->edge_inv;
511   if (tc_edge_inv) {
512     tc_edge_inv->edge_inv = NULL;
513   }
514
515   olsr_cookie_free(tc_edge_mem_cookie, tc_edge);
516 }
517
518 /**
519  * Delete all destinations that have a lower ANSN.
520  *
521  * @param tc the entry to delete edges from
522  * @return TRUE if any destinations were deleted, FALSE if not
523  */
524 bool
525 olsr_delete_outdated_tc_edges(struct tc_entry *tc)
526 {
527   struct tc_edge_entry *tc_edge;
528   bool retval = false;
529
530 #if 0
531   OLSR_PRINTF(5, "TC: deleting outdated TC-edge entries\n");
532 #endif
533
534   OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
535     if (SEQNO_GREATER_THAN(tc->ansn, tc_edge->ansn)) {
536       olsr_delete_tc_edge_entry(tc_edge);
537       retval = true;
538     }
539   }
540   OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
541
542   return retval;
543 }
544
545 /**
546  * Delete all destinations that are inside the borders but
547  * not updated in the last tc.
548  *
549  * @param tc the entry to delete edges from
550  * @param ansn the advertised neighbor set sequence number
551  * @return 1 if any destinations were deleted 0 if not
552  */
553 static int
554 olsr_delete_revoked_tc_edges(struct tc_entry *tc, uint16_t ansn, union olsr_ip_addr *lower_border, union olsr_ip_addr *upper_border)
555 {
556   struct tc_edge_entry *tc_edge;
557   int retval = 0;
558
559 #if 0
560   OLSR_PRINTF(5, "TC: deleting MPRS\n");
561 #endif
562
563   bool passedLowerBorder = false;
564
565   OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
566     if (!passedLowerBorder) {
567       if (avl_comp_default(lower_border, &tc_edge->T_dest_addr) <= 0) {
568         passedLowerBorder = true;
569       } else {
570         continue;
571       }
572     }
573
574     if (passedLowerBorder) {
575       if (avl_comp_default(upper_border, &tc_edge->T_dest_addr) <= 0) {
576         break;
577       }
578     }
579
580     if (SEQNO_GREATER_THAN(ansn, tc_edge->ansn)) {
581       olsr_delete_tc_edge_entry(tc_edge);
582       retval = 1;
583     }
584   }
585   OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
586
587   if (retval)
588     changes_topology = true;
589   return retval;
590 }
591
592 /**
593  * Update an edge registered on an entry.
594  * Creates new edge-entries if not registered.
595  * Bases update on a received TC message
596  *
597  * @param entry the TC entry to check
598  * @pkt the TC edge entry in the packet
599  * @return 1 if entries are added 0 if not
600  */
601 static int
602 olsr_tc_update_edge(struct tc_entry *tc, uint16_t ansn, const unsigned char **curr, union olsr_ip_addr *neighbor)
603 {
604   struct tc_edge_entry *tc_edge;
605   int edge_change;
606
607   edge_change = 0;
608
609   /*
610    * Fetch the per-edge data
611    */
612   pkt_get_ipaddress(curr, neighbor);
613
614   /* First check if we know this edge */
615   tc_edge = olsr_lookup_tc_edge(tc, neighbor);
616
617   if (!tc_edge) {
618
619     /*
620      * Yet unknown - create it.
621      * Check if the address is allowed.
622      */
623     if (!olsr_validate_address(neighbor)) {
624       return 0;
625     }
626
627     tc_edge = olsr_add_tc_edge_entry(tc, neighbor, ansn);
628
629     olsr_deserialize_tc_lq_pair(curr, tc_edge);
630     edge_change = 1;
631
632   } else {
633
634     /*
635      * We know this edge - Update entry.
636      */
637     tc_edge->ansn = ansn;
638
639     /*
640      * Update link quality if configured.
641      */
642     if (olsr_cnf->lq_level > 0) {
643       olsr_deserialize_tc_lq_pair(curr, tc_edge);
644     }
645
646     /*
647      * Update the etx.
648      */
649     if (olsr_calc_tc_edge_entry_etx(tc_edge)) {
650       if (tc->msg_hops <= olsr_cnf->lq_dlimit) {
651         edge_change = 1;
652       }
653     }
654 #if DEBUG
655     if (edge_change) {
656       OLSR_PRINTF(1, "TC:   chg edge entry %s\n", olsr_tc_edge_to_string(tc_edge));
657     }
658 #endif
659
660   }
661
662   return edge_change;
663 }
664
665 /**
666  * Lookup an edge hanging off a TC entry.
667  *
668  * @param entry the entry to check
669  * @param dst_addr the destination address to check for
670  * @return a pointer to the tc_edge found - or NULL
671  */
672 struct tc_edge_entry *
673 olsr_lookup_tc_edge(struct tc_entry *tc, union olsr_ip_addr *edge_addr)
674 {
675   struct avl_node *edge_node;
676
677 #if 0
678   OLSR_PRINTF(1, "TC: lookup dst\n");
679 #endif
680
681   edge_node = avl_find(&tc->edge_tree, edge_addr);
682
683   return (edge_node ? edge_tree2tc_edge(edge_node) : NULL);
684 }
685
686 /**
687  * Print the topology table to stdout
688  */
689 void
690 olsr_print_tc_table(void)
691 {
692 #ifndef NODEBUG
693   /* The whole function makes no sense without it. */
694   struct tc_entry *tc;
695   const int ipwidth = olsr_cnf->ip_version == AF_INET ? 15 : 30;
696
697   OLSR_PRINTF(1, "\n--- %s ------------------------------------------------- TOPOLOGY\n\n" "%-*s %-*s %-14s  %s\n",
698               olsr_wallclock_string(), ipwidth, "Source IP addr", ipwidth, "Dest IP addr", "      LQ      ", "ETX");
699
700   OLSR_FOR_ALL_TC_ENTRIES(tc) {
701     struct tc_edge_entry *tc_edge;
702     OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
703       struct ipaddr_str addrbuf, dstaddrbuf;
704       struct lqtextbuffer lqbuffer1, lqbuffer2;
705
706       OLSR_PRINTF(1, "%-*s %-*s %-14s %s\n", ipwidth, olsr_ip_to_string(&addrbuf, &tc->addr), ipwidth,
707                   olsr_ip_to_string(&dstaddrbuf, &tc_edge->T_dest_addr), get_tc_edge_entry_text(tc_edge, '/', &lqbuffer1),
708                   get_linkcost_text(tc_edge->cost, false, &lqbuffer2));
709
710     } OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
711   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
712 #endif
713 }
714
715 /*
716  * calculate the border IPs of a tc edge set according to the border flags
717  *
718  * @param lower border flag
719  * @param pointer to lower border ip
720  * @param upper border flag
721  * @param pointer to upper border ip
722  * @result 1 if lower/upper border ip have been set
723  */
724 static int
725 olsr_calculate_tc_border(uint8_t lower_border, union olsr_ip_addr *lower_border_ip, uint8_t upper_border,
726                          union olsr_ip_addr *upper_border_ip)
727 {
728   if (lower_border == 0 && upper_border == 0) {
729     return 0;
730   }
731   if (lower_border == 0xff) {
732     memset(lower_border_ip, 0, sizeof(lower_border_ip));
733   } else {
734     int i;
735
736     lower_border--;
737     for (i = 0; i < lower_border / 8; i++) {
738       lower_border_ip->v6.s6_addr[olsr_cnf->ipsize - i - 1] = 0;
739     }
740     lower_border_ip->v6.s6_addr[olsr_cnf->ipsize - lower_border / 8 - 1] &= (0xff << (lower_border & 7));
741     lower_border_ip->v6.s6_addr[olsr_cnf->ipsize - lower_border / 8 - 1] |= (1 << (lower_border & 7));
742   }
743
744   if (upper_border == 0xff) {
745     memset(upper_border_ip, 0xff, sizeof(upper_border_ip));
746   } else {
747     int i;
748
749     upper_border--;
750
751     for (i = 0; i < upper_border / 8; i++) {
752       upper_border_ip->v6.s6_addr[olsr_cnf->ipsize - i - 1] = 0;
753     }
754     upper_border_ip->v6.s6_addr[olsr_cnf->ipsize - upper_border / 8 - 1] &= (0xff << (upper_border & 7));
755     upper_border_ip->v6.s6_addr[olsr_cnf->ipsize - upper_border / 8 - 1] |= (1 << (upper_border & 7));
756   }
757   return 1;
758 }
759
760 /*
761  * Process an incoming TC or TC_LQ message.
762  *
763  * If the message is interesting enough, update our edges for it,
764  * trigger SPF and finally flood it to all our 2way neighbors.
765  *
766  * The order for extracting data off the message does matter,
767  * as every call to pkt_get increases the packet offset and
768  * hence the spot we are looking at.
769  */
770 bool
771 olsr_input_tc(union olsr_message * msg, struct interface * input_if __attribute__ ((unused)), union olsr_ip_addr * from_addr)
772 {
773   struct ipaddr_str buf;
774   uint16_t size, msg_seq, ansn;
775   uint8_t type, ttl, msg_hops, lower_border, upper_border;
776   olsr_reltime vtime;
777   union olsr_ip_addr originator;
778   const unsigned char *limit, *curr;
779   struct tc_entry *tc;
780
781   union olsr_ip_addr lower_border_ip, upper_border_ip;
782   int borderSet = 0;
783
784   curr = (void *)msg;
785   if (!msg) {
786     return false;
787   }
788
789   /* We are only interested in TC message types. */
790   pkt_get_u8(&curr, &type);
791   if ((type != LQ_TC_MESSAGE) && (type != TC_MESSAGE)) {
792     return false;
793   }
794
795   pkt_get_reltime(&curr, &vtime);
796   pkt_get_u16(&curr, &size);
797
798   pkt_get_ipaddress(&curr, &originator);
799
800   /* Copy header values */
801   pkt_get_u8(&curr, &ttl);
802   pkt_get_u8(&curr, &msg_hops);
803   pkt_get_u16(&curr, &msg_seq);
804   pkt_get_u16(&curr, &ansn);
805
806   /* Get borders */
807   pkt_get_u8(&curr, &lower_border);
808   pkt_get_u8(&curr, &upper_border);
809
810   tc = olsr_lookup_tc_entry(&originator);
811
812   if (tc && 0 != tc->edge_tree.count) {
813     if (olsr_seq_inrange_high((int)tc->msg_seq - TC_SEQNO_WINDOW, tc->msg_seq, msg_seq)
814         && olsr_seq_inrange_high((int)tc->ansn - TC_ANSN_WINDOW, tc->ansn, ansn)) {
815
816       /*
817        * Ignore already seen seq/ansn values (small window for mesh memory)
818        */
819       if ((tc->msg_seq == msg_seq) || (tc->ignored++ < 32)) {
820         return false;
821       }
822
823       OLSR_PRINTF(1, "Ignored to much LQTC's for %s, restarting\n", olsr_ip_to_string(&buf, &originator));
824
825     } else if (!olsr_seq_inrange_high(tc->msg_seq, (int)tc->msg_seq + TC_SEQNO_WINDOW * TC_SEQNO_WINDOW_MULT, msg_seq)
826                || !olsr_seq_inrange_low(tc->ansn, (int)tc->ansn + TC_ANSN_WINDOW * TC_ANSN_WINDOW_MULT, ansn)) {
827
828       /*
829        * Only accept future seq/ansn values (large window for node reconnects).
830        * Restart in all other cases. Ignore a single stray message.
831        */
832       if (!tc->err_seq_valid) {
833         tc->err_seq = msg_seq;
834         tc->err_seq_valid = true;
835       }
836       if (tc->err_seq == msg_seq) {
837         return false;
838       }
839
840       OLSR_PRINTF(2, "Detected node restart for %s\n", olsr_ip_to_string(&buf, &originator));
841     }
842   }
843
844   /*
845    * Generate a new tc_entry in the lsdb and store the sequence number.
846    */
847   if (!tc) {
848     tc = olsr_add_tc_entry(&originator);
849   }
850
851   /*
852    * Update the tc entry.
853    */
854   tc->msg_hops = msg_hops;
855   tc->msg_seq = msg_seq;
856   tc->ansn = ansn;
857   tc->ignored = 0;
858   tc->err_seq_valid = false;
859
860   /*
861    * If the sender interface (NB: not originator) of this message
862    * is not in the symmetric 1-hop neighborhood of this node, the
863    * message MUST be discarded.
864    */
865   if (check_neighbor_link(from_addr) != SYM_LINK) {
866     OLSR_PRINTF(2, "Received TC from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
867     return false;
868   }
869
870   OLSR_PRINTF(1, "Processing TC from %s, seq 0x%04x\n", olsr_ip_to_string(&buf, &originator), tc->msg_seq);
871
872   /*
873    * Now walk the edge advertisements contained in the packet.
874    */
875
876   limit = (unsigned char *)msg + size;
877   borderSet = 0;
878   while (curr < limit) {
879     if (olsr_tc_update_edge(tc, ansn, &curr, &upper_border_ip)) {
880       changes_topology = true;
881     }
882
883     if (!borderSet) {
884       borderSet = 1;
885       memcpy(&lower_border_ip, &upper_border_ip, sizeof(lower_border_ip));
886     }
887   }
888
889   /*
890    * Calculate real border IPs.
891    */
892   if (borderSet) {
893     borderSet = olsr_calculate_tc_border(lower_border, &lower_border_ip, upper_border, &upper_border_ip);
894   }
895
896   /*
897    * Set or change the expiration timer accordingly.
898    */
899   olsr_set_timer(&tc->validity_timer, vtime, OLSR_TC_VTIME_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_tc_entry, tc,
900                  tc_validity_timer_cookie->ci_id);
901
902   if (borderSet) {
903
904     /*
905      * Delete all old tc edges within borders.
906      */
907     olsr_delete_revoked_tc_edges(tc, ansn, &lower_border_ip, &upper_border_ip);
908   } else {
909
910     /*
911      * Kick the the edge garbage collection timer. In the meantime hopefully
912      * all edges belonging to a multipart neighbor set will arrive.
913      */
914     olsr_set_timer(&tc->edge_gc_timer, OLSR_TC_EDGE_GC_TIME, OLSR_TC_EDGE_GC_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_tc_edge_gc,
915                    tc, tc_edge_gc_timer_cookie->ci_id);
916   }
917
918   /* Forward the message */
919   return true;
920 }
921
922 /*
923  * Local Variables:
924  * c-basic-offset: 2
925  * indent-tabs-mode: nil
926  * End:
927  */