Merge branch 'release-0.6.5'
[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 adr (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 tc the TC entry to delete
276  */
277 void
278 olsr_delete_tc_entry(struct tc_entry *tc)
279 {
280   struct tc_edge_entry *tc_edge;
281   struct rt_path *rtp;
282
283   /* delete gateway if available */
284 #ifdef __linux__
285   olsr_delete_gateway_entry(&tc->addr, FORCE_DELETE_GW_ENTRY, false);
286 #endif /* __linux__ */
287   /*
288    * Delete the rt_path for ourselves.
289    */
290   olsr_delete_routing_table(&tc->addr, olsr_cnf->maxplen, &tc->addr);
291
292   /* The edgetree and prefix tree must be empty before */
293   OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
294     olsr_delete_tc_edge_entry(tc_edge);
295   } OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
296
297   OLSR_FOR_ALL_PREFIX_ENTRIES(tc, rtp) {
298     olsr_delete_rt_path(rtp);
299   } OLSR_FOR_ALL_PREFIX_ENTRIES_END(tc, rtp);
300
301   /* Stop running timers */
302   olsr_stop_timer(tc->edge_gc_timer);
303   tc->edge_gc_timer = NULL;
304   olsr_stop_timer(tc->validity_timer);
305   tc->validity_timer = NULL;
306
307   avl_delete(&tc_tree, &tc->vertex_node);
308   olsr_unlock_tc_entry(tc);
309 }
310
311 /**
312  * Look up a entry from the TC tree based on address
313  *
314  * @param adr the address to look for
315  * @return the entry found or NULL
316  */
317 struct tc_entry *
318 olsr_lookup_tc_entry(union olsr_ip_addr *adr)
319 {
320   struct avl_node *node;
321
322   node = avl_find(&tc_tree, adr);
323
324   return (node ? vertex_tree2tc(node) : NULL);
325 }
326
327 /*
328  * Lookup a tc entry. Creates one if it does not exist yet.
329  */
330 struct tc_entry *
331 olsr_locate_tc_entry(union olsr_ip_addr *adr)
332 {
333   struct tc_entry *tc;
334
335   if (!(tc = olsr_lookup_tc_entry(adr))) {
336     return olsr_add_tc_entry(adr);
337   }
338   return tc;
339 }
340
341 /**
342  * Format tc_edge contents into a buffer.
343  */
344 char *
345 olsr_tc_edge_to_string(struct tc_edge_entry *tc_edge)
346 {
347   static char buf[128];
348   struct ipaddr_str addrbuf, dstbuf;
349   struct tc_entry *tc = tc_edge->tc;
350   struct lqtextbuffer lqbuffer1, lqbuffer2;
351
352   snprintf(buf, sizeof(buf), "%s > %s, cost (%6s) %s", olsr_ip_to_string(&addrbuf, &tc->addr),
353            olsr_ip_to_string(&dstbuf, &tc_edge->T_dest_addr), get_tc_edge_entry_text(tc_edge, '/', &lqbuffer1),
354            get_linkcost_text(tc_edge->cost, false, &lqbuffer2));
355
356   return buf;
357 }
358
359 /**
360  * Wrapper for the timer callback.
361  * A TC entry has not been refreshed in time.
362  * Remove it from the link-state database.
363  */
364 static void
365 olsr_expire_tc_entry(void *context)
366 {
367   struct tc_entry *tc;
368   struct ipaddr_str buf;
369
370   tc = (struct tc_entry *)context;
371
372   OLSR_PRINTF(3, "TC: expire node entry %s\n", olsr_ip_to_string(&buf, &tc->addr));
373
374   tc->validity_timer = NULL;
375
376   olsr_delete_tc_entry(tc);
377   changes_topology = true;
378 }
379
380 /**
381  * Wrapper for the timer callback.
382  * Does the garbage collection of older ansn entries after no edge addition to
383  * the TC entry has happened for OLSR_TC_EDGE_GC_TIME.
384  */
385 static void
386 olsr_expire_tc_edge_gc(void *context)
387 {
388   struct tc_entry *tc;
389   struct ipaddr_str buf;
390
391   tc = (struct tc_entry *)context;
392
393   OLSR_PRINTF(3, "TC: expire edge entry %s\n", olsr_ip_to_string(&buf, &tc->addr));
394
395   tc->edge_gc_timer = NULL;
396
397   if (olsr_delete_outdated_tc_edges(tc)) {
398     changes_topology = true;
399   }
400 }
401
402 /*
403  * If the edge does not have a minimum acceptable link quality
404  * set the etx cost to infinity such that it gets ignored during
405  * SPF calculation.
406  *
407  * @return 1 if the change of the etx value was relevant
408  */
409 bool
410 olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *tc_edge)
411 {
412   /*
413    * Some sanity check before recalculating the etx.
414    */
415   if (olsr_cnf->lq_level < 1) {
416     return false;
417   }
418
419   tc_edge->cost = olsr_calc_tc_cost(tc_edge);
420   return true;
421 }
422
423 /**
424  * Add a new tc_edge_entry to the tc_edge_tree
425  *
426  * @param tc the tc entry
427  * @param addr (last)adr address of the entry
428  * @param ansn ansn of this edge
429  * @return a pointer to the created entry
430  */
431 struct tc_edge_entry *
432 olsr_add_tc_edge_entry(struct tc_entry *tc, union olsr_ip_addr *addr, uint16_t ansn)
433 {
434 #ifdef DEBUG
435   struct ipaddr_str buf;
436 #endif /* DEBUG */
437   struct tc_entry *tc_neighbor;
438   struct tc_edge_entry *tc_edge, *tc_edge_inv;
439
440   tc_edge = olsr_cookie_malloc(tc_edge_mem_cookie);
441   if (!tc_edge) {
442     return NULL;
443   }
444
445   /* Fill entry */
446   tc_edge->T_dest_addr = *addr;
447   tc_edge->ansn = ansn;
448   tc_edge->edge_node.key = &tc_edge->T_dest_addr;
449
450   /*
451    * Insert into the edge tree.
452    */
453   avl_insert(&tc->edge_tree, &tc_edge->edge_node, AVL_DUP_NO);
454   olsr_lock_tc_entry(tc);
455
456   /*
457    * Connect backpointer.
458    */
459   tc_edge->tc = tc;
460
461   /*
462    * Check if the neighboring router and the inverse edge is in the lsdb.
463    * Create short cuts to the inverse edge for faster SPF execution.
464    */
465   tc_neighbor = olsr_lookup_tc_entry(&tc_edge->T_dest_addr);
466   if (tc_neighbor) {
467 #ifdef DEBUG
468     OLSR_PRINTF(1, "TC:   found neighbor tc_entry %s\n", olsr_ip_to_string(&buf, &tc_neighbor->addr));
469 #endif /* DEBUG */
470
471     tc_edge_inv = olsr_lookup_tc_edge(tc_neighbor, &tc->addr);
472     if (tc_edge_inv) {
473 #ifdef DEBUG
474       OLSR_PRINTF(1, "TC:   found inverse edge for %s\n", olsr_ip_to_string(&buf, &tc_edge_inv->T_dest_addr));
475 #endif /* DEBUG */
476
477       /*
478        * Connect the edges mutually.
479        */
480       tc_edge_inv->edge_inv = tc_edge;
481       tc_edge->edge_inv = tc_edge_inv;
482
483     }
484   }
485
486   /*
487    * Update the etx.
488    */
489   olsr_calc_tc_edge_entry_etx(tc_edge);
490
491 #ifdef DEBUG
492   OLSR_PRINTF(1, "TC: add edge entry %s\n", olsr_tc_edge_to_string(tc_edge));
493 #endif /* DEBUG */
494
495   return tc_edge;
496 }
497
498 /**
499  * Delete a TC edge entry.
500  *
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  * @param lower_border the lower border
558  * @param upper_border the upper border
559  * @return 1 if any destinations were deleted 0 if not
560  */
561 static int
562 olsr_delete_revoked_tc_edges(struct tc_entry *tc, uint16_t ansn, union olsr_ip_addr *lower_border, union olsr_ip_addr *upper_border)
563 {
564   struct tc_edge_entry *tc_edge;
565   int retval = 0;
566
567   bool passedLowerBorder = false;
568
569   OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
570     if (!passedLowerBorder) {
571       if (avl_comp_default(lower_border, &tc_edge->T_dest_addr) <= 0) {
572         passedLowerBorder = true;
573       } else {
574         continue;
575       }
576     }
577
578     if (passedLowerBorder) {
579       if (avl_comp_default(upper_border, &tc_edge->T_dest_addr) <= 0) {
580         break;
581       }
582     }
583
584     if (SEQNO_GREATER_THAN(ansn, tc_edge->ansn)) {
585       olsr_delete_tc_edge_entry(tc_edge);
586       retval = 1;
587     }
588   }
589   OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
590
591   if (retval)
592     changes_topology = true;
593   return retval;
594 }
595
596 /**
597  * Update an edge registered on an entry.
598  * Creates new edge-entries if not registered.
599  * Bases update on a received TC message
600  *
601  * @param tc the TC entry to check
602  * @param ansn the ansn of the edge
603  * @param curr pointer to the packet
604  * @param neighbor the neighbor of the edge
605  * @return 1 if entries are added 0 if not
606  */
607 static int
608 olsr_tc_update_edge(struct tc_entry *tc, uint16_t ansn, const unsigned char **curr, union olsr_ip_addr *neighbor)
609 {
610   struct tc_edge_entry *tc_edge;
611   int edge_change;
612
613   edge_change = 0;
614
615   /*
616    * Fetch the per-edge data
617    */
618   pkt_get_ipaddress(curr, neighbor);
619
620   /* First check if we know this edge */
621   tc_edge = olsr_lookup_tc_edge(tc, neighbor);
622
623   if (!tc_edge) {
624
625     /*
626      * Yet unknown - create it.
627      * Check if the address is allowed.
628      */
629     if (!olsr_validate_address(neighbor)) {
630       return 0;
631     }
632
633     tc_edge = olsr_add_tc_edge_entry(tc, neighbor, ansn);
634
635     olsr_deserialize_tc_lq_pair(curr, tc_edge);
636     edge_change = 1;
637
638   } else {
639
640     /*
641      * We know this edge - Update entry.
642      */
643     tc_edge->ansn = ansn;
644
645     /*
646      * Update link quality if configured.
647      */
648     if (olsr_cnf->lq_level > 0) {
649       olsr_deserialize_tc_lq_pair(curr, tc_edge);
650     }
651
652     /*
653      * Update the etx.
654      */
655     if (olsr_calc_tc_edge_entry_etx(tc_edge)) {
656       edge_change = 1;
657     }
658 #if defined DEBUG && DEBUG
659     if (edge_change) {
660       OLSR_PRINTF(1, "TC:   chg edge entry %s\n", olsr_tc_edge_to_string(tc_edge));
661     }
662 #endif /* defined DEBUG && DEBUG */
663
664   }
665
666   return edge_change;
667 }
668
669 /**
670  * Lookup an edge hanging off a TC entry.
671  *
672  * @param tc the entry to check
673  * @param edge_addr the destination address to check for
674  * @return a pointer to the tc_edge found - or NULL
675  */
676 struct tc_edge_entry *
677 olsr_lookup_tc_edge(struct tc_entry *tc, union olsr_ip_addr *edge_addr)
678 {
679   struct avl_node *edge_node;
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 #ifndef NODEBUG
690 void
691 olsr_print_tc_table(void)
692 {
693   /* The whole function makes no sense without it. */
694   struct tc_entry *tc;
695   const int ipwidth = olsr_cnf->ip_version == AF_INET ? (INET_ADDRSTRLEN - 1) : (INET6_ADDRSTRLEN - 1);
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 }
713 #endif /* NODEBUG */
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   bool emptyTC;
781
782   union olsr_ip_addr lower_border_ip, upper_border_ip;
783   int borderSet = 0;
784
785   curr = (void *)msg;
786   if (!msg) {
787     return false;
788   }
789
790   /* We are only interested in TC message types. */
791   pkt_get_u8(&curr, &type);
792   if ((type != LQ_TC_MESSAGE) && (type != TC_MESSAGE)) {
793     return false;
794   }
795
796   /*
797    * If the sender interface (NB: not originator) of this message
798    * is not in the symmetric 1-hop neighborhood of this node, the
799    * message MUST be discarded.
800    */
801   if (check_neighbor_link(from_addr) != SYM_LINK) {
802     OLSR_PRINTF(2, "Received TC from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
803     return false;
804   }
805
806   pkt_get_reltime(&curr, &vtime);
807   pkt_get_u16(&curr, &size);
808
809   pkt_get_ipaddress(&curr, &originator);
810
811   /* Copy header values */
812   pkt_get_u8(&curr, &ttl);
813   pkt_get_u8(&curr, &msg_hops);
814   pkt_get_u16(&curr, &msg_seq);
815   pkt_get_u16(&curr, &ansn);
816
817   /* Get borders */
818   pkt_get_u8(&curr, &lower_border);
819   pkt_get_u8(&curr, &upper_border);
820
821   tc = olsr_lookup_tc_entry(&originator);
822
823   if (vtime < (olsr_reltime)(olsr_cnf->min_tc_vtime*1000)) {
824           vtime = (olsr_reltime)(olsr_cnf->min_tc_vtime*1000);
825   }
826
827   if (tc && 0 != tc->edge_tree.count) {
828     if (olsr_seq_inrange_high((int)tc->msg_seq - TC_SEQNO_WINDOW, tc->msg_seq, msg_seq)
829         && olsr_seq_inrange_high((int)tc->ansn - TC_ANSN_WINDOW, tc->ansn, ansn)) {
830
831       /*
832        * Ignore already seen seq/ansn values (small window for mesh memory)
833        */
834       if ((tc->msg_seq == msg_seq) || (tc->ignored++ < 32)) {
835         return false;
836       }
837
838       OLSR_PRINTF(1, "Ignored to much LQTC's for %s, restarting\n", olsr_ip_to_string(&buf, &originator));
839
840     } else if (!olsr_seq_inrange_high(tc->msg_seq, (int)tc->msg_seq + TC_SEQNO_WINDOW * TC_SEQNO_WINDOW_MULT, msg_seq)
841                || !olsr_seq_inrange_low(tc->ansn, (int)tc->ansn + TC_ANSN_WINDOW * TC_ANSN_WINDOW_MULT, ansn)) {
842
843       /*
844        * Only accept future seq/ansn values (large window for node reconnects).
845        * Restart in all other cases. Ignore a single stray message.
846        */
847       if (!tc->err_seq_valid) {
848         tc->err_seq = msg_seq;
849         tc->err_seq_valid = true;
850       }
851       if (tc->err_seq == msg_seq) {
852         return false;
853       }
854
855       OLSR_PRINTF(2, "Detected node restart for %s\n", olsr_ip_to_string(&buf, &originator));
856     }
857   }
858
859   /*
860    * Generate a new tc_entry in the lsdb and store the sequence number.
861    */
862   if (!tc) {
863     tc = olsr_add_tc_entry(&originator);
864   }
865
866   /*
867    * Update the tc entry.
868    */
869   tc->msg_hops = msg_hops;
870   tc->msg_seq = msg_seq;
871   tc->ansn = ansn;
872   tc->ignored = 0;
873   tc->err_seq_valid = false;
874
875   OLSR_PRINTF(1, "Processing TC from %s, seq 0x%04x\n", olsr_ip_to_string(&buf, &originator), tc->msg_seq);
876
877   /*
878    * Now walk the edge advertisements contained in the packet.
879    */
880
881   limit = (unsigned char *)msg + size;
882   borderSet = 0;
883   emptyTC = curr >= limit;
884   while (curr < limit) {
885     if (olsr_tc_update_edge(tc, ansn, &curr, &upper_border_ip)) {
886       changes_topology = true;
887     }
888
889     if (!borderSet) {
890       borderSet = 1;
891       memcpy(&lower_border_ip, &upper_border_ip, sizeof(lower_border_ip));
892     }
893   }
894
895   /*
896    * Calculate real border IPs.
897    */
898   if (borderSet) {
899     borderSet = olsr_calculate_tc_border(lower_border, &lower_border_ip, upper_border, &upper_border_ip);
900   }
901
902   /*
903    * Set or change the expiration timer accordingly.
904    */
905   olsr_set_timer(&tc->validity_timer, vtime, OLSR_TC_VTIME_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_tc_entry, tc,
906                  tc_validity_timer_cookie);
907
908   if (emptyTC && lower_border == 0xff && upper_border == 0xff) {
909     /* handle empty TC with border flags 0xff */
910     memset(&lower_border_ip, 0x00, sizeof(lower_border_ip));
911     memset(&upper_border_ip, 0xff, sizeof(upper_border_ip));
912     borderSet = 1;
913   }
914
915   if (borderSet) {
916
917     /*
918      * Delete all old tc edges within borders.
919      */
920     olsr_delete_revoked_tc_edges(tc, ansn, &lower_border_ip, &upper_border_ip);
921   } else {
922
923     /*
924      * Kick the the edge garbage collection timer. In the meantime hopefully
925      * all edges belonging to a multipart neighbor set will arrive.
926      */
927     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,
928                    tc, tc_edge_gc_timer_cookie);
929   }
930
931   if (emptyTC && borderSet) {
932     /* cleanup MIDs and HNAs if all edges have been erased by
933      * an empty TC, then alert the duplicate set and kill the
934      * tc entry */
935     olsr_cleanup_mid(&originator);
936     olsr_cleanup_hna(&originator);
937     olsr_cleanup_duplicates(&originator);
938
939     olsr_delete_tc_entry(tc);
940   }
941   /* Forward the message */
942   return true;
943 }
944
945 /*
946  * Local Variables:
947  * c-basic-offset: 2
948  * indent-tabs-mode: nil
949  * End:
950  */