remove the per tc_edge timer
[olsrd.git] / src / routing_table.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * RIB implementation (c) 2007, Hannes Gredler (hannes@gredler.at)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without 
8  * modification, are permitted provided that the following conditions 
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright 
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright 
14  *   notice, this list of conditions and the following disclaimer in 
15  *   the documentation and/or other materials provided with the 
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its 
18  *   contributors may be used to endorse or promote products derived 
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include "routing_table.h"
43 #include "ipcalc.h"
44 #include "defs.h"
45 #include "two_hop_neighbor_table.h"
46 #include "tc_set.h"
47 #include "mid_set.h"
48 #include "neighbor_table.h"
49 #include "olsr.h"
50 #include "link_set.h"
51 #include "common/avl.h"
52 #include "lq_route.h"
53 #include "net_olsr.h"
54
55 #include <assert.h>
56
57 /*
58  * Sven-Ola: if the current internet gateway is switched, the
59  * NAT connection info is lost for any active TCP/UDP session.
60  * For this reason, we do not want to switch if the advantage
61  * is only minimal (cost of loosing all NATs is too high).
62  * The following rt_path keeps track of the current inet gw.
63  */
64 static struct rt_path *current_inetgw = NULL;
65
66 /* Root of our RIB */
67 struct avl_tree routingtree;
68
69 /*
70  * Keep a version number for detecting outdated elements
71  * in the per rt_entry rt_path subtree.
72  */
73 unsigned int routingtree_version;
74
75 /**
76  * Bump the version number of the routing tree.
77  *
78  * After route-insertion compare the version number of the routes
79  * against the version number of the table.
80  * This is a lightweight detection if a node or prefix went away,
81  * rather than brute force old vs. new rt_entry comparision.
82  */
83 unsigned int
84 olsr_bump_routingtree_version(void)
85 {
86   return routingtree_version++;
87 }
88
89 /**
90  * avl_comp_ipv4_prefix
91  *
92  * compare two ipv4 prefixes.
93  * first compare the prefixes, then
94  *  then compare the prefix lengths.
95  *
96  * return 0 if there is an exact match and
97  * -1 / +1 depending on being smaller or bigger.
98  */
99 int
100 avl_comp_ipv4_prefix (const void *prefix1, const void *prefix2)
101 {       
102   const struct olsr_ip_prefix *pfx1 = prefix1;
103   const struct olsr_ip_prefix *pfx2 = prefix2;
104   const olsr_u32_t addr1 = ntohl(pfx1->prefix.v4.s_addr);
105   const olsr_u32_t addr2 = ntohl(pfx2->prefix.v4.s_addr);
106
107   /* prefix */
108   if (addr1 < addr2) {
109     return -1;
110   }
111   if (addr1 > addr2) {
112     return +1;
113   }
114
115   /* prefix length */
116   if (pfx1->prefix_len < pfx2->prefix_len) {
117     return -1;
118   }
119   if (pfx1->prefix_len > pfx2->prefix_len) {
120     return +1;
121   }
122
123   return 0;
124 }
125
126 /**
127  * avl_comp_ipv6_prefix
128  *
129  * compare two ipv6 prefixes.
130  * first compare the prefixes, then
131  *  then compare the prefix lengths.
132  *
133  * return 0 if there is an exact match and
134  * -1 / +1 depending on being smaller or bigger.
135  */
136 int
137 avl_comp_ipv6_prefix (const void *prefix1, const void *prefix2)
138 {       
139   int res;
140   const struct olsr_ip_prefix *pfx1 = prefix1;
141   const struct olsr_ip_prefix *pfx2 = prefix2;
142
143   /* prefix */
144   res = memcmp(&pfx1->prefix.v6, &pfx2->prefix.v6, 16);
145   if (res != 0) {
146     return res;
147   } 
148   /* prefix length */
149   if (pfx1->prefix_len < pfx2->prefix_len) {
150     return -1;
151   }
152   if (pfx1->prefix_len > pfx2->prefix_len) {
153     return +1;
154   }
155
156   return 0;
157 }
158
159 /**
160  * Initialize the routingtree and kernel change queues.
161  */
162 void
163 olsr_init_routing_table(void)
164 {
165   /* the routing tree */
166   avl_init(&routingtree, avl_comp_prefix_default);
167   routingtree_version = 0;
168 }
169
170 /**
171  * Look up a maxplen entry (= /32 or /128) in the routing table.
172  *
173  * @param dst the address of the entry
174  *
175  * @return a pointer to a rt_entry struct 
176  * representing the route entry.
177  */
178 struct rt_entry *
179 olsr_lookup_routing_table(const union olsr_ip_addr *dst)
180 {
181   struct avl_node *rt_tree_node;
182   struct olsr_ip_prefix prefix;
183
184   prefix.prefix = *dst;
185   prefix.prefix_len = olsr_cnf->maxplen;
186
187   rt_tree_node = avl_find(&routingtree, &prefix);
188
189   return rt_tree_node ? rt_tree2rt(rt_tree_node) : NULL;
190 }
191
192 /**
193  * Update gateway/interface/etx/hopcount and the version for a route path.
194  */
195 void
196 olsr_update_rt_path(struct rt_path *rtp, struct tc_entry *tc,
197                     struct link_entry *link)
198 {
199
200   rtp->rtp_version = routingtree_version;
201
202   /* gateway */
203   rtp->rtp_nexthop.gateway = link->neighbor_iface_addr;
204
205   /* interface */
206   rtp->rtp_nexthop.iif_index = link->inter->if_index;
207
208   /* metric/etx */
209   rtp->rtp_metric.hops = tc->hops;
210   rtp->rtp_metric.cost = tc->path_cost;
211 }
212
213 /**
214  * Alloc and key a new rt_entry.
215  */
216 static struct rt_entry *
217 olsr_alloc_rt_entry(struct olsr_ip_prefix *prefix)
218 {
219   struct rt_entry *rt = olsr_malloc(sizeof(struct rt_entry), __FUNCTION__);
220   if (!rt) {
221     return NULL;
222   }
223
224   memset(rt, 0, sizeof(*rt));
225   
226   /* Mark this entry as fresh (see process_routes.c:512) */
227   rt->rt_nexthop.iif_index = -1;
228
229   /* set key and backpointer prior to tree insertion */
230   rt->rt_dst = *prefix;
231
232   rt->rt_tree_node.key = &rt->rt_dst;
233   avl_insert(&routingtree, &rt->rt_tree_node, AVL_DUP_NO);
234
235   /* init the originator subtree */
236   avl_init(&rt->rt_path_tree, avl_comp_default);
237
238   return rt;
239 }
240
241 /**
242  * Alloc and key a new rt_path.
243  */
244 static struct rt_path *
245 olsr_alloc_rt_path(struct tc_entry *tc,
246                    struct olsr_ip_prefix *prefix, olsr_u8_t origin)
247 {
248   struct rt_path *rtp = olsr_malloc(sizeof(struct rt_path), __FUNCTION__);
249
250   if (!rtp) {
251     return NULL;
252   }
253
254   memset(rtp, 0, sizeof(*rtp));
255
256   rtp->rtp_dst = *prefix;
257
258   /* set key and backpointer prior to tree insertion */
259   rtp->rtp_prefix_tree_node.key = &rtp->rtp_dst;
260
261   /* insert to the tc prefix tree */
262   avl_insert(&tc->prefix_tree, &rtp->rtp_prefix_tree_node, AVL_DUP_NO);
263   olsr_lock_tc_entry(tc);
264
265   /* backlink to the owning tc entry */
266   rtp->rtp_tc = tc;
267
268   /* store the origin of the route */
269   rtp->rtp_origin = origin;
270
271   return rtp;
272 }
273
274 /**
275  * Create a route entry for a given rt_path and
276  * insert it into the global RIB tree.
277  */
278 void
279 olsr_insert_rt_path(struct rt_path *rtp, struct tc_entry *tc,
280                     struct link_entry *link)
281 {
282   struct rt_entry *rt;
283   struct avl_node *node;
284
285   /*
286    * no unreachable routes please.
287    */
288   if (tc->path_cost == ROUTE_COST_BROKEN) {
289     return;
290   }
291
292   /*
293    * No bogus prefix lengths.
294    */
295   if (rtp->rtp_dst.prefix_len > olsr_cnf->maxplen) {
296     return;
297   }
298
299   /*
300    * first check if there is a route_entry for the prefix.
301    */
302   node = avl_find(&routingtree, &rtp->rtp_dst);
303
304   if (!node) {
305
306     /* no route entry yet */
307     rt = olsr_alloc_rt_entry(&rtp->rtp_dst);
308
309     if (!rt) {
310       return;
311     }
312
313   } else {
314     rt = rt_tree2rt(node);
315   }
316
317
318   /* Now insert the rt_path to the owning rt_entry tree */
319   rtp->rtp_originator = tc->addr;
320
321   /* set key and backpointer prior to tree insertion */
322   rtp->rtp_tree_node.key = &rtp->rtp_originator;
323
324   /* insert to the route entry originator tree */
325   avl_insert(&rt->rt_path_tree, &rtp->rtp_tree_node, AVL_DUP_NO);
326
327   /* backlink to the owning route entry */
328   rtp->rtp_rt = rt;
329
330   /* update the version field and relevant parameters */
331   olsr_update_rt_path(rtp, tc, link);
332 }
333
334 /**
335  * Unlink and free a rt_path.
336  */
337 void
338 olsr_delete_rt_path(struct rt_path *rtp)
339 {
340
341   /* remove from the originator tree */
342   if (rtp->rtp_rt) {
343     avl_delete(&rtp->rtp_rt->rt_path_tree, &rtp->rtp_tree_node);
344     rtp->rtp_rt = NULL;
345   }
346
347   /* remove from the tc prefix tree */
348   if (rtp->rtp_tc) {
349     avl_delete(&rtp->rtp_tc->prefix_tree, &rtp->rtp_prefix_tree_node);
350     olsr_unlock_tc_entry(rtp->rtp_tc);
351     rtp->rtp_tc = NULL;
352   }
353
354   /* no current inet gw if the rt_path is removed */
355   if (current_inetgw == rtp) {
356     current_inetgw = NULL;
357   }
358
359   free(rtp);
360 }
361
362
363 /**
364  * Check if there is an interface or gateway change.
365  */
366 olsr_bool
367 olsr_nh_change(const struct rt_nexthop *nh1, const struct rt_nexthop *nh2)
368 {
369   if (!ipequal(&nh1->gateway, &nh2->gateway) ||
370       (nh1->iif_index != nh2->iif_index)) {
371     return OLSR_TRUE;
372   }
373   return OLSR_FALSE;
374 }
375
376 /**
377  * Check if there is a hopcount change.
378  */
379 olsr_bool
380 olsr_hopcount_change(const struct rt_metric *met1, const struct rt_metric *met2)
381 {
382   return (met1->hops != met2->hops);
383 }
384
385 /**
386  * Depending if flat_metric is configured and the kernel fib operation
387  * return the hopcount metric of a route.
388  * For adds this is the metric of best rour after olsr_rt_best() election,
389  * for deletes this is the metric of the route that got stored in the rt_entry,
390  * during route installation.
391  */
392 olsr_u8_t
393 olsr_fib_metric(const struct rt_metric *met)
394 {
395   if (FIBM_CORRECT == olsr_cnf->fib_metric) {
396     return met->hops;
397   }
398   return RT_METRIC_DEFAULT;
399 }
400
401 /**
402  * depending on the operation (add/chg/del) the nexthop
403  * field from the route entry or best route path shall be used.
404  */
405 const struct rt_nexthop *
406 olsr_get_nh(const struct rt_entry *rt)
407 {
408
409   if(rt->rt_best) {
410
411     /* this is a route add/chg - grab nexthop from the best route. */
412     return &rt->rt_best->rtp_nexthop;
413   } 
414   
415   /* this is a route deletion - all routes are gone. */
416   return &rt->rt_nexthop;
417 }
418
419 /**
420  * compare two route paths.
421  *
422  * returns TRUE if the first path is better
423  * than the second one, FALSE otherwise.
424  */
425 static olsr_bool
426 olsr_cmp_rtp(const struct rt_path *rtp1, const struct rt_path *rtp2, const struct rt_path *inetgw)
427 {
428     olsr_linkcost etx1 = rtp1->rtp_metric.cost;
429     olsr_linkcost etx2 = rtp2->rtp_metric.cost;
430     if (inetgw == rtp1) etx1 *= olsr_cnf->lq_nat_thresh;
431     if (inetgw == rtp2) etx2 *= olsr_cnf->lq_nat_thresh;
432
433     /* etx comes first */
434     if (etx1 < etx2) {
435       return OLSR_TRUE;
436     }
437
438     /* hopcount is next tie breaker */
439     if ((etx1 == etx2) &&
440         (rtp1->rtp_metric.hops < rtp2->rtp_metric.hops)) {
441       return OLSR_TRUE;
442     }
443
444     /* originator (which is guaranteed to be unique) is final tie breaker */
445     if ((rtp1->rtp_metric.hops == rtp2->rtp_metric.hops) &&
446         (memcmp(&rtp1->rtp_originator, &rtp2->rtp_originator,
447                 olsr_cnf->ipsize) == -1)) {
448       return OLSR_TRUE;
449     }
450
451     return OLSR_FALSE;
452 }
453
454 /**
455  * compare the best path of two route entries.
456  *
457  * returns TRUE if the first entry is better
458  * than the second one, FALSE otherwise.
459  */
460 olsr_bool
461 olsr_cmp_rt(const struct rt_entry *rt1, const struct rt_entry *rt2)
462 {
463   return olsr_cmp_rtp(rt1->rt_best, rt2->rt_best, NULL);
464 }
465
466 /**
467  * run best route selection among a
468  * set of identical prefixes.
469  */
470 void
471 olsr_rt_best(struct rt_entry *rt)
472 {
473   /* grab the first entry */
474   struct avl_node *node = avl_walk_first(&rt->rt_path_tree);
475
476   assert(node != 0); /* should not happen */
477
478   rt->rt_best = rtp_tree2rtp(node);
479
480   /* walk all remaining originator entries */
481   while ((node = avl_walk_next(node))) {
482     struct rt_path *rtp = rtp_tree2rtp(node);
483
484     if (olsr_cmp_rtp(rtp, rt->rt_best, current_inetgw)) {
485       rt->rt_best = rtp;
486     }
487   }
488
489   if (0 == rt->rt_dst.prefix_len) {
490     current_inetgw = rt->rt_best;
491   }
492 }
493
494 /**
495  * Insert a prefix into the prefix tree hanging off a lsdb (tc) entry.
496  *
497  * Check if the candidate route (we call this a rt_path) is known,
498  * if not create it.
499  * Upon post-SPF processing (if the node is reachable) the prefix
500  * will be finally inserted into the global RIB.
501  *
502  *@param dst the destination
503  *@param plen the prefix length
504  *@param originator the originating router
505  *
506  *@return the new rt_path struct
507  */
508 struct rt_path *
509 olsr_insert_routing_table(union olsr_ip_addr *dst, int plen,
510                           union olsr_ip_addr *originator, int origin)
511 {
512 #if !defined(NODEBUG) && defined(DEBUG)
513   struct ipaddr_str dstbuf, origbuf;
514 #endif
515   struct tc_entry *tc;
516   struct rt_path *rtp;
517   struct avl_node *node;
518   struct olsr_ip_prefix prefix;
519
520   /*
521    * No bogus prefix lengths.
522    */
523   if (plen > olsr_cnf->maxplen) {
524     return NULL;
525   }
526
527 #ifdef DEBUG
528   OLSR_PRINTF(1, "RIB: add prefix %s/%u from %s\n",
529               olsr_ip_to_string(&dstbuf, dst), plen,
530               olsr_ip_to_string(&origbuf, originator));
531 #endif
532
533   /*
534    * For all routes we use the tc_entry as an hookup point.
535    * If the tc_entry is disconnected, i.e. has no edges it will not
536    * be explored during SPF run.
537    */
538   tc = olsr_locate_tc_entry(originator);
539   
540   /*
541    * first check if there is a rt_path for the prefix.
542    */
543   prefix.prefix = *dst;
544   prefix.prefix_len = plen;
545
546   node = avl_find(&tc->prefix_tree, &prefix);
547
548   if (!node) {
549
550     /* no rt_path for this prefix yet */
551     rtp = olsr_alloc_rt_path(tc, &prefix, origin);
552
553     if (!rtp) {
554       return NULL;
555     }
556
557     /* overload the hna change bit for flagging a prefix change */
558     changes_hna = OLSR_TRUE;
559
560   } else {
561     rtp = rtp_prefix_tree2rtp(node);
562   }
563
564   return rtp;
565 }
566
567 /**
568  * Delete a prefix from the prefix tree hanging off a lsdb (tc) entry.
569  */
570 void
571 olsr_delete_routing_table(union olsr_ip_addr *dst, int plen,
572                           union olsr_ip_addr *originator)
573 {
574 #if !defined(NODEBUG) && defined(DEBUG)
575   struct ipaddr_str buf;
576 #endif
577
578   struct tc_entry *tc;
579   struct rt_path *rtp;
580   struct avl_node *node;
581   struct olsr_ip_prefix prefix;
582
583   /*
584    * No bogus prefix lengths.
585    */
586   if (plen > olsr_cnf->maxplen) {
587     return;
588   }
589
590 #ifdef DEBUG
591   OLSR_PRINTF(1, "RIB: del prefix %s/%u from %s\n",
592               olsr_ip_to_string(&buf, dst), plen,
593               olsr_ip_to_string(&buf, originator));
594 #endif
595
596   tc = olsr_lookup_tc_entry(originator);
597   if (!tc) {
598     return;
599   }
600
601   /*
602    * Grab the rt_path for the prefix.
603    */
604   prefix.prefix = *dst;
605   prefix.prefix_len = plen;
606
607   node = avl_find(&tc->prefix_tree, &prefix);
608
609   if (node) {
610     rtp = rtp_prefix_tree2rtp(node);
611     olsr_delete_rt_path(rtp);
612
613     /* overload the hna change bit for flagging a prefix change */
614     changes_hna = OLSR_TRUE;
615   }
616 }
617
618 /**
619  * format a route entry into a buffer
620  */
621 char *
622 olsr_rt_to_string(const struct rt_entry *rt)
623 {
624   static char buff[128];
625   struct ipaddr_str prefixstr, gwstr;
626
627   snprintf(buff, sizeof(buff),
628            "%s/%u via %s",
629            olsr_ip_to_string(&prefixstr, &rt->rt_dst.prefix),
630            rt->rt_dst.prefix_len,
631            olsr_ip_to_string(&gwstr, &rt->rt_nexthop.gateway));
632
633   return buff;
634 }
635
636 /**
637  * format a route path into a buffer
638  */
639 char *
640 olsr_rtp_to_string(const struct rt_path *rtp)
641 {
642   static char buff[128];
643   struct ipaddr_str prefixstr, origstr, gwstr;
644   struct rt_entry *rt = rtp->rtp_rt;
645   struct lqtextbuffer lqbuffer;
646   
647   snprintf(buff, sizeof(buff),
648            "%s/%u from %s via %s, "
649            "cost %s, metric %u, v %u",
650            olsr_ip_to_string(&prefixstr, &rt->rt_dst.prefix),
651            rt->rt_dst.prefix_len,
652            olsr_ip_to_string(&origstr, &rtp->rtp_originator),
653            olsr_ip_to_string(&gwstr, &rtp->rtp_nexthop.gateway),
654            get_linkcost_text(rtp->rtp_metric.cost, OLSR_TRUE, &lqbuffer),
655            rtp->rtp_metric.hops,
656            rtp->rtp_version);
657
658   return buff;
659 }
660
661 /**
662  * Print the routingtree to STDOUT
663  *
664  */
665 void
666 olsr_print_routing_table(struct avl_tree *tree)
667 {
668 #ifndef NODEBUG
669   /* The whole function makes no sense without it. */
670   struct avl_node *rt_tree_node;
671   struct lqtextbuffer lqbuffer;
672   
673   OLSR_PRINTF(6, "ROUTING TABLE\n");
674
675   for (rt_tree_node = avl_walk_first(tree);
676        rt_tree_node != NULL;
677        rt_tree_node = avl_walk_next(rt_tree_node)) {
678     struct avl_node *rtp_tree_node;
679     struct ipaddr_str prefixstr, origstr, gwstr;
680     struct rt_entry *rt = rt_tree2rt(rt_tree_node);
681
682     /* first the route entry */
683     OLSR_PRINTF(6, "%s/%u, via %s, best-originator %s\n",
684            olsr_ip_to_string(&prefixstr, &rt->rt_dst.prefix),
685            rt->rt_dst.prefix_len,
686            olsr_ip_to_string(&origstr, &rt->rt_nexthop.gateway),
687            olsr_ip_to_string(&gwstr, &rt->rt_best->rtp_originator));
688
689     /* walk the per-originator path tree of routes */
690     for (rtp_tree_node = avl_walk_first(&rt->rt_path_tree);
691          rtp_tree_node != NULL;
692          rtp_tree_node = avl_walk_next(rtp_tree_node)) {
693       struct rt_path *rtp = rtp_tree2rtp(rtp_tree_node);
694       OLSR_PRINTF(6, "\tfrom %s, cost %s, metric %u, via %s, %s, v %u\n",
695              olsr_ip_to_string(&origstr, &rtp->rtp_originator),
696              get_linkcost_text(rtp->rtp_metric.cost, OLSR_TRUE, &lqbuffer),
697              rtp->rtp_metric.hops,
698              olsr_ip_to_string(&gwstr, &rtp->rtp_nexthop.gateway),
699              if_ifwithindex_name(rt->rt_nexthop.iif_index),
700              rtp->rtp_version);    
701     }
702   }
703 #endif
704   tree = NULL; /* squelch compiler warnings */
705 }
706
707 /*
708  * Local Variables:
709  * c-basic-offset: 2
710  * End:
711  */