eliminate the data field from an avl_node
[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
264   /* backlink to the owning tc entry */
265   rtp->rtp_tc = tc;
266
267   /* store the origin of the route */
268   rtp->rtp_origin = origin;
269
270   return rtp;
271 }
272
273 /**
274  * Create a route entry for a given rt_path and
275  * insert it into the global RIB tree.
276  */
277 void
278 olsr_insert_rt_path(struct rt_path *rtp, struct tc_entry *tc,
279                     struct link_entry *link)
280 {
281   struct rt_entry *rt;
282   struct avl_node *node;
283
284   /*
285    * no unreachable routes please.
286    */
287   if (tc->path_cost == ROUTE_COST_BROKEN) {
288     return;
289   }
290
291   /*
292    * No bogus prefix lengths.
293    */
294   if (rtp->rtp_dst.prefix_len > olsr_cnf->maxplen) {
295     return;
296   }
297
298   /*
299    * first check if there is a route_entry for the prefix.
300    */
301   node = avl_find(&routingtree, &rtp->rtp_dst);
302
303   if (!node) {
304
305     /* no route entry yet */
306     rt = olsr_alloc_rt_entry(&rtp->rtp_dst);
307
308     if (!rt) {
309       return;
310     }
311
312   } else {
313     rt = rt_tree2rt(node);
314   }
315
316
317   /* Now insert the rt_path to the owning rt_entry tree */
318   rtp->rtp_originator = tc->addr;
319
320   /* set key and backpointer prior to tree insertion */
321   rtp->rtp_tree_node.key = &rtp->rtp_originator;
322
323   /* insert to the route entry originator tree */
324   avl_insert(&rt->rt_path_tree, &rtp->rtp_tree_node, AVL_DUP_NO);
325
326   /* backlink to the owning route entry */
327   rtp->rtp_rt = rt;
328
329   /* update the version field and relevant parameters */
330   olsr_update_rt_path(rtp, tc, link);
331 }
332
333 /**
334  * Unlink and free a rt_path.
335  */
336 static void
337 olsr_free_rt_path(struct rt_path *rtp)
338 {
339
340   /* remove from the originator tree */
341   if (rtp->rtp_rt) {
342     avl_delete(&rtp->rtp_rt->rt_path_tree, &rtp->rtp_tree_node);
343     rtp->rtp_rt = NULL;
344   }
345
346   /* remove from the tc prefix tree */
347   if (rtp->rtp_tc) {
348     avl_delete(&rtp->rtp_tc->prefix_tree, &rtp->rtp_prefix_tree_node);
349     rtp->rtp_tc = NULL;
350   }
351
352   /* no current inet gw if the rt_path is removed */
353   if (current_inetgw == rtp) {
354     current_inetgw = NULL;
355   }
356
357   free(rtp);
358 }
359
360
361 /**
362  * Check if there is an interface or gateway change.
363  */
364 olsr_bool
365 olsr_nh_change(const struct rt_nexthop *nh1, const struct rt_nexthop *nh2)
366 {
367   if (!ipequal(&nh1->gateway, &nh2->gateway) ||
368       (nh1->iif_index != nh2->iif_index)) {
369     return OLSR_TRUE;
370   }
371   return OLSR_FALSE;
372 }
373
374 /**
375  * Check if there is a hopcount change.
376  */
377 olsr_bool
378 olsr_hopcount_change(const struct rt_metric *met1, const struct rt_metric *met2)
379 {
380   return (met1->hops != met2->hops);
381 }
382
383 /**
384  * Depending if flat_metric is configured and the kernel fib operation
385  * return the hopcount metric of a route.
386  * For adds this is the metric of best rour after olsr_rt_best() election,
387  * for deletes this is the metric of the route that got stored in the rt_entry,
388  * during route installation.
389  */
390 olsr_u8_t
391 olsr_fib_metric(const struct rt_metric *met)
392 {
393   if (FIBM_CORRECT == olsr_cnf->fib_metric) {
394     return met->hops;
395   }
396   return RT_METRIC_DEFAULT;
397 }
398
399 /**
400  * depending on the operation (add/chg/del) the nexthop
401  * field from the route entry or best route path shall be used.
402  */
403 const struct rt_nexthop *
404 olsr_get_nh(const struct rt_entry *rt)
405 {
406
407   if(rt->rt_best) {
408
409     /* this is a route add/chg - grab nexthop from the best route. */
410     return &rt->rt_best->rtp_nexthop;
411   } 
412   
413   /* this is a route deletion - all routes are gone. */
414   return &rt->rt_nexthop;
415 }
416
417 /**
418  * compare two route paths.
419  *
420  * returns TRUE if the first path is better
421  * than the second one, FALSE otherwise.
422  */
423 static olsr_bool
424 olsr_cmp_rtp(const struct rt_path *rtp1, const struct rt_path *rtp2, const struct rt_path *inetgw)
425 {
426     olsr_linkcost etx1 = rtp1->rtp_metric.cost;
427     olsr_linkcost etx2 = rtp2->rtp_metric.cost;
428     if (inetgw == rtp1) etx1 *= olsr_cnf->lq_nat_thresh;
429     if (inetgw == rtp2) etx2 *= olsr_cnf->lq_nat_thresh;
430
431     /* etx comes first */
432     if (etx1 < etx2) {
433       return OLSR_TRUE;
434     }
435
436     /* hopcount is next tie breaker */
437     if ((etx1 == etx2) &&
438         (rtp1->rtp_metric.hops < rtp2->rtp_metric.hops)) {
439       return OLSR_TRUE;
440     }
441
442     /* originator (which is guaranteed to be unique) is final tie breaker */
443     if ((rtp1->rtp_metric.hops == rtp2->rtp_metric.hops) &&
444         (memcmp(&rtp1->rtp_originator, &rtp2->rtp_originator,
445                 olsr_cnf->ipsize) == -1)) {
446       return OLSR_TRUE;
447     }
448
449     return OLSR_FALSE;
450 }
451
452 /**
453  * compare the best path of two route entries.
454  *
455  * returns TRUE if the first entry is better
456  * than the second one, FALSE otherwise.
457  */
458 olsr_bool
459 olsr_cmp_rt(const struct rt_entry *rt1, const struct rt_entry *rt2)
460 {
461   return olsr_cmp_rtp(rt1->rt_best, rt2->rt_best, NULL);
462 }
463
464 /**
465  * run best route selection among a
466  * set of identical prefixes.
467  */
468 void
469 olsr_rt_best(struct rt_entry *rt)
470 {
471   /* grab the first entry */
472   struct avl_node *node = avl_walk_first(&rt->rt_path_tree);
473
474   assert(node != 0); /* should not happen */
475
476   rt->rt_best = rtp_tree2rtp(node);
477
478   /* walk all remaining originator entries */
479   while ((node = avl_walk_next(node))) {
480     struct rt_path *rtp = rtp_tree2rtp(node);
481
482     if (olsr_cmp_rtp(rtp, rt->rt_best, current_inetgw)) {
483       rt->rt_best = rtp;
484     }
485   }
486
487   if (0 == rt->rt_dst.prefix_len) {
488     current_inetgw = rt->rt_best;
489   }
490 }
491
492 /**
493  * Insert a prefix into the prefix tree hanging off a lsdb (tc) entry.
494  *
495  * Check if the candidate route (we call this a rt_path) is known,
496  * if not create it.
497  * Upon post-SPF processing (if the node is reachable) the prefix
498  * will be finally inserted into the global RIB.
499  *
500  *@param dst the destination
501  *@param plen the prefix length
502  *@param originator the originating router
503  *
504  *@return the new rt_path struct
505  */
506 struct rt_path *
507 olsr_insert_routing_table(union olsr_ip_addr *dst, int plen,
508                           union olsr_ip_addr *originator, int origin)
509 {
510 #if !defined(NODEBUG) && defined(DEBUG)
511   struct ipaddr_str dstbuf, origbuf;
512 #endif
513   struct tc_entry *tc;
514   struct rt_path *rtp;
515   struct avl_node *node;
516   struct olsr_ip_prefix prefix;
517
518   /*
519    * No bogus prefix lengths.
520    */
521   if (plen > olsr_cnf->maxplen) {
522     return NULL;
523   }
524
525 #ifdef DEBUG
526   OLSR_PRINTF(1, "RIB: add prefix %s/%u from %s\n",
527               olsr_ip_to_string(&dstbuf, dst), plen,
528               olsr_ip_to_string(&origbuf, originator));
529 #endif
530
531   /*
532    * For internal routes the tc_entry must already exist.
533    * For all other routes we may create it as an edgeless
534    * hookup point. If so he tc_entry has no edges it will not
535    * be explored during SPF run.
536    */
537   tc = olsr_locate_tc_entry(originator);
538   
539   /*
540    * first check if there is a rt_path for the prefix.
541    */
542   prefix.prefix = *dst;
543   prefix.prefix_len = plen;
544
545   node = avl_find(&tc->prefix_tree, &prefix);
546
547   if (!node) {
548
549     /* no rt_path for this prefix yet */
550     rtp = olsr_alloc_rt_path(tc, &prefix, origin);
551
552     if (!rtp) {
553       return NULL;
554     }
555
556     /* overload the hna change bit for flagging a prefix change */
557     changes_hna = OLSR_TRUE;
558
559   } else {
560     rtp = rtp_prefix_tree2rtp(node);
561   }
562
563   return rtp;
564 }
565
566 /**
567  * Delete a prefix from the prefix tree hanging off a lsdb (tc) entry.
568  */
569 void
570 olsr_delete_routing_table(union olsr_ip_addr *dst, int plen,
571                           union olsr_ip_addr *originator)
572 {
573 #if !defined(NODEBUG) && defined(DEBUG)
574   struct ipaddr_str buf;
575 #endif
576
577   struct tc_entry *tc;
578   struct rt_path *rtp;
579   struct avl_node *node;
580   struct olsr_ip_prefix prefix;
581
582   /*
583    * No bogus prefix lengths.
584    */
585   if (plen > olsr_cnf->maxplen) {
586     return;
587   }
588
589 #ifdef DEBUG
590   OLSR_PRINTF(1, "RIB: del prefix %s/%u from %s\n",
591               olsr_ip_to_string(&buf, dst), plen,
592               olsr_ip_to_string(&buf, originator));
593 #endif
594
595   tc = olsr_lookup_tc_entry(originator);
596   if (!tc) {
597     return;
598   }
599
600   /*
601    * Grab the rt_path for the prefix.
602    */
603   prefix.prefix = *dst;
604   prefix.prefix_len = plen;
605
606   node = avl_find(&tc->prefix_tree, &prefix);
607
608   if (node) {
609     rtp = rtp_prefix_tree2rtp(node);
610     olsr_free_rt_path(rtp);
611
612     /* overload the hna change bit for flagging a prefix change */
613     changes_hna = OLSR_TRUE;
614   }
615 }
616
617 /**
618  * format a route entry into a buffer
619  */
620 char *
621 olsr_rt_to_string(const struct rt_entry *rt)
622 {
623   static char buff[128];
624   struct ipaddr_str prefixstr, gwstr;
625
626   snprintf(buff, sizeof(buff),
627            "%s/%u via %s",
628            olsr_ip_to_string(&prefixstr, &rt->rt_dst.prefix),
629            rt->rt_dst.prefix_len,
630            olsr_ip_to_string(&gwstr, &rt->rt_nexthop.gateway));
631
632   return buff;
633 }
634
635 /**
636  * format a route path into a buffer
637  */
638 char *
639 olsr_rtp_to_string(const struct rt_path *rtp)
640 {
641   static char buff[128];
642   struct ipaddr_str prefixstr, origstr, gwstr;
643   struct rt_entry *rt = rtp->rtp_rt;
644   struct lqtextbuffer lqbuffer;
645   
646   snprintf(buff, sizeof(buff),
647            "%s/%u from %s via %s, "
648            "cost %s, metric %u, v %u",
649            olsr_ip_to_string(&prefixstr, &rt->rt_dst.prefix),
650            rt->rt_dst.prefix_len,
651            olsr_ip_to_string(&origstr, &rtp->rtp_originator),
652            olsr_ip_to_string(&gwstr, &rtp->rtp_nexthop.gateway),
653            get_linkcost_text(rtp->rtp_metric.cost, OLSR_TRUE, &lqbuffer),
654            rtp->rtp_metric.hops,
655            rtp->rtp_version);
656
657   return buff;
658 }
659
660 /**
661  * Print the routingtree to STDOUT
662  *
663  */
664 void
665 olsr_print_routing_table(struct avl_tree *tree)
666 {
667 #ifndef NODEBUG
668   /* The whole function makes no sense without it. */
669   struct avl_node *rt_tree_node;
670   struct lqtextbuffer lqbuffer;
671   
672   OLSR_PRINTF(6, "ROUTING TABLE\n");
673
674   for (rt_tree_node = avl_walk_first(tree);
675        rt_tree_node != NULL;
676        rt_tree_node = avl_walk_next(rt_tree_node)) {
677     struct avl_node *rtp_tree_node;
678     struct ipaddr_str prefixstr, origstr, gwstr;
679     struct rt_entry *rt = rt_tree2rt(rt_tree_node);
680
681     /* first the route entry */
682     OLSR_PRINTF(6, "%s/%u, via %s, best-originator %s\n",
683            olsr_ip_to_string(&prefixstr, &rt->rt_dst.prefix),
684            rt->rt_dst.prefix_len,
685            olsr_ip_to_string(&origstr, &rt->rt_nexthop.gateway),
686            olsr_ip_to_string(&gwstr, &rt->rt_best->rtp_originator));
687
688     /* walk the per-originator path tree of routes */
689     for (rtp_tree_node = avl_walk_first(&rt->rt_path_tree);
690          rtp_tree_node != NULL;
691          rtp_tree_node = avl_walk_next(rtp_tree_node)) {
692       struct rt_path *rtp = rtp_tree2rtp(rtp_tree_node);
693       OLSR_PRINTF(6, "\tfrom %s, cost %s, metric %u, via %s, %s, v %u\n",
694              olsr_ip_to_string(&origstr, &rtp->rtp_originator),
695              get_linkcost_text(rtp->rtp_metric.cost, OLSR_TRUE, &lqbuffer),
696              rtp->rtp_metric.hops,
697              olsr_ip_to_string(&gwstr, &rtp->rtp_nexthop.gateway),
698              if_ifwithindex_name(rt->rt_nexthop.iif_index),
699              rtp->rtp_version);    
700     }
701   }
702 #endif
703   tree = NULL; /* squelch compiler warnings */
704 }
705
706 /*
707  * Local Variables:
708  * c-basic-offset: 2
709  * End:
710  */