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