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