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