Merge branch 'master' into mpr_rework
[oonf.git] / src-plugins / olsrv2 / olsrv2 / olsrv2_routing.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
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 /**
43  * @file
44  */
45
46 #include <errno.h>
47
48 #include "common/avl.h"
49 #include "common/avl_comp.h"
50 #include "common/common_types.h"
51 #include "common/list.h"
52 #include "common/netaddr.h"
53 #include "core/oonf_logging.h"
54 #include "core/os_core.h"
55 #include "subsystems/oonf_class.h"
56 #include "subsystems/oonf_rfc5444.h"
57 #include "subsystems/oonf_timer.h"
58 #include "subsystems/os_routing.h"
59
60 #include "nhdp/nhdp_db.h"
61 #include "nhdp/nhdp_domain.h"
62 #include "nhdp/nhdp_interfaces.h"
63
64 #include "olsrv2/olsrv2_internal.h"
65 #include "olsrv2/olsrv2_lan.h"
66 #include "olsrv2/olsrv2_originator.h"
67 #include "olsrv2/olsrv2_tc.h"
68 #include "olsrv2/olsrv2_routing.h"
69 #include "olsrv2/olsrv2.h"
70
71 /* Prototypes */
72 static void _run_dijkstra(struct nhdp_domain *domain, int af_family,
73     bool use_non_ss, bool use_ss);
74 static struct olsrv2_routing_entry *_add_entry(
75     struct nhdp_domain *, struct os_route_key *prefix);
76 static void _remove_entry(struct olsrv2_routing_entry *);
77 static void _insert_into_working_tree(struct olsrv2_tc_target *target,
78     struct nhdp_neighbor *neigh, uint32_t linkcost,
79     uint32_t path_cost, uint8_t path_hops,
80     uint8_t distance, bool single_hop,
81     const struct netaddr *last_originator);
82 static void _prepare_routes(struct nhdp_domain *);
83 static void _prepare_nodes(void);
84 static bool _check_ssnode_split(struct nhdp_domain *domain, int af_family);
85 static void _add_one_hop_nodes(struct nhdp_domain *domain, int family, bool, bool);
86 static void _handle_working_queue(struct nhdp_domain *, bool, bool);
87 static void _handle_nhdp_routes(struct nhdp_domain *);
88 static void _add_route_to_kernel_queue(struct olsrv2_routing_entry *rtentry);
89 static void _process_dijkstra_result(struct nhdp_domain *);
90 static void _process_kernel_queue(void);
91
92 static void _cb_mpr_update(struct nhdp_domain *);
93 static void _cb_metric_update(struct nhdp_domain *);
94 static void _cb_trigger_dijkstra(struct oonf_timer_instance *);
95
96 static void _cb_route_finished(struct os_route *route, int error);
97
98 /* Domain parameter of dijkstra algorithm */
99 static struct olsrv2_routing_domain _domain_parameter[NHDP_MAXIMUM_DOMAINS];
100
101 /* memory class for routing entries */
102 static struct oonf_class _rtset_entry = {
103   .name = "Olsrv2 Routing Set Entry",
104   .size = sizeof(struct olsrv2_routing_entry),
105 };
106
107 /* rate limitation for dijkstra algorithm */
108 static struct oonf_timer_class _dijkstra_timer_info = {
109   .name = "Dijkstra rate limit timer",
110   .callback = _cb_trigger_dijkstra,
111 };
112
113 static struct oonf_timer_instance _rate_limit_timer = {
114   .class = &_dijkstra_timer_info
115 };
116
117 static bool _trigger_dijkstra = false;
118
119 /* callback for NHDP domain events */
120 static struct nhdp_domain_listener _nhdp_listener = {
121   .mpr_update = _cb_mpr_update,
122   .metric_update = _cb_metric_update,
123 };
124
125 /* status variables for domain changes */
126 static uint16_t _ansn;
127 static bool _domain_changed[NHDP_MAXIMUM_DOMAINS];
128 static bool _update_ansn;
129
130
131 /* global datastructures for routing */
132 static struct avl_tree _routing_tree[NHDP_MAXIMUM_DOMAINS];
133 static struct list_entity _routing_filter_list;
134
135 static struct avl_tree _dijkstra_working_tree;
136 static struct list_entity _kernel_queue;
137
138 static bool _initiate_shutdown = false;
139 static bool _freeze_routes = false;
140
141 /**
142  * Initialize olsrv2 dijkstra and routing code
143  */
144 int
145 olsrv2_routing_init(void) {
146   int i;
147
148   /* initialize domain change tracker */
149   if (os_core_get_random(&_ansn, sizeof(_ansn))) {
150     return -1;
151   }
152
153   nhdp_domain_listener_add(&_nhdp_listener);
154   memset(_domain_changed, 0, sizeof(_domain_changed));
155   _update_ansn = false;
156
157
158   oonf_class_add(&_rtset_entry);
159   oonf_timer_add(&_dijkstra_timer_info);
160
161   for (i=0; i<NHDP_MAXIMUM_DOMAINS; i++) {
162     avl_init(&_routing_tree[i], os_routing_avl_cmp_route_key, false);
163   }
164   list_init_head(&_routing_filter_list);
165   avl_init(&_dijkstra_working_tree, avl_comp_uint32, true);
166   list_init_head(&_kernel_queue);
167
168   return 0;
169 }
170
171 /**
172  * Trigger cleanup of olsrv2 dijkstra and routing code
173  */
174 void
175 olsrv2_routing_initiate_shutdown(void) {
176   struct olsrv2_routing_entry *entry, *e_it;
177   int i;
178
179   /* remember we are in shutdown */
180   _initiate_shutdown = true;
181   _freeze_routes = false;
182
183   /* remove all routes */
184   for (i=0; i<NHDP_MAXIMUM_DOMAINS; i++) {
185     avl_for_each_element_safe(&_routing_tree[i], entry, _node, e_it) {
186       /* stop internal route processing */
187       entry->route.cb_finished = NULL;
188       os_routing_interrupt(&entry->route);
189       entry->route.cb_finished = _cb_route_finished;
190
191       if (entry->set) {
192         entry->set = false;
193         _add_route_to_kernel_queue(entry);
194       }
195     }
196   }
197
198   _process_kernel_queue();
199 }
200
201 /**
202  * Finalize cleanup of olsrv2 dijkstra and routing code
203  */
204 void
205 olsrv2_routing_cleanup(void) {
206   struct olsrv2_routing_entry *entry, *e_it;
207   struct olsrv2_routing_filter *filter, *f_it;
208   int i;
209
210   nhdp_domain_listener_remove(&_nhdp_listener);
211   oonf_timer_stop(&_rate_limit_timer);
212
213   for (i=0; i<NHDP_MAXIMUM_DOMAINS; i++) {
214     avl_for_each_element_safe(&_routing_tree[i], entry, _node, e_it) {
215       /* remove entry from database */
216       _remove_entry(entry);
217     }
218   }
219
220   list_for_each_element_safe(&_routing_filter_list, filter, _node, f_it) {
221     olsrv2_routing_filter_remove(filter);
222   }
223
224   oonf_timer_remove(&_dijkstra_timer_info);
225   oonf_class_remove(&_rtset_entry);
226 }
227
228 /**
229  * @return current answer set number for local topology database
230  */
231 uint16_t
232 olsrv2_routing_get_ansn(void) {
233   return _ansn;
234 }
235
236 /**
237  * Trigger a new dijkstra as soon as we are back in the mainloop
238  * (unless the rate limitation timer is active, then we will wait for it)
239  */
240 void
241 olsrv2_routing_trigger_update(void) {
242   _trigger_dijkstra = true;
243   if (!oonf_timer_is_active(&_rate_limit_timer)) {
244     /* trigger as soon as we hit the next time slice */
245     oonf_timer_set(&_rate_limit_timer, 1);
246   }
247
248   OONF_DEBUG(LOG_OLSRV2_ROUTING, "Trigger routing update");
249 }
250
251 /**
252  * Freeze all modifications of all OLSRv2 routing table
253  * @param freeze true to freeze tables, false to update them to
254  *   the dijkstra results again.
255  */
256 void
257 olsrv2_routing_freeze_routes(bool freeze) {
258   if (_freeze_routes == freeze) {
259     return;
260   }
261
262   _freeze_routes = freeze;
263   if (!freeze) {
264     /* make sure we have a current routing table */
265     olsrv2_routing_trigger_update();
266   }
267 }
268
269 /**
270  * @param domain nhdp domain
271  * @return routing domain parameters
272  */
273 const struct olsrv2_routing_domain *
274 olsrv2_routing_get_parameters(struct nhdp_domain *domain) {
275   return &_domain_parameter[domain->index];
276 }
277
278 /**
279  * Mark a domain as changed to trigger a dijkstra run
280  * @param domain NHDP domain, NULL for all domains
281  */
282 void
283 olsrv2_routing_domain_changed(struct nhdp_domain *domain) {
284   if (domain) {
285     _domain_changed[domain->index] = true;
286
287     olsrv2_routing_trigger_update();
288     return;
289   }
290
291   list_for_each_element(nhdp_domain_get_list(), domain, _node) {
292     olsrv2_routing_domain_changed(domain);
293   }
294 }
295
296 /**
297  * Trigger dijkstra and routing update now
298  * @param skip_wait true to ignore rate limitation timer
299  */
300 void
301 olsrv2_routing_force_update(bool skip_wait) {
302   struct nhdp_domain *domain;
303   bool splitv4, splitv6;
304
305   if (_initiate_shutdown || _freeze_routes) {
306     /* no dijkstra anymore when in shutdown */
307     return;
308   }
309
310   /* handle dijkstra rate limitation timer */
311   if (oonf_timer_is_active(&_rate_limit_timer)) {
312     if (!skip_wait) {
313       /* trigger dijkstra later */
314       _trigger_dijkstra = true;
315
316       OONF_DEBUG(LOG_OLSRV2_ROUTING, "Delay Dijkstra");
317       return;
318     }
319     oonf_timer_stop(&_rate_limit_timer);
320   }
321
322   if (_update_ansn) {
323     _ansn++;
324     _update_ansn = false;
325     OONF_DEBUG(LOG_OLSRV2_ROUTING, "Update ANSN to %u", _ansn);
326   }
327
328   OONF_DEBUG(LOG_OLSRV2_ROUTING, "Run Dijkstra");
329
330   list_for_each_element(nhdp_domain_get_list(), domain, _node) {
331     /* check if dijkstra is necessary */
332     if (!_domain_changed[domain->index]) {
333       /* nothing to do for this domain */
334       continue;
335     }
336     _domain_changed[domain->index] = false;
337
338     /* initialize dijkstra specific fields */
339     _prepare_routes(domain);
340     _prepare_nodes();
341
342     /* run IPv4 dijkstra (might be two times because of source-specific data) */
343     splitv4 = _check_ssnode_split(domain, AF_INET);
344     _run_dijkstra(domain, AF_INET, true, !splitv4);
345
346     /* run IPv6 dijkstra (might be two times because of source-specific data) */
347     splitv6 = _check_ssnode_split(domain, AF_INET6);
348     _run_dijkstra(domain, AF_INET6, true, !splitv6);
349
350     /* handle source-specific sub-topology if necessary */
351     if (splitv4 || splitv6) {
352       /* re-initialize dijkstra specific node fields */
353       _prepare_nodes();
354
355       if (splitv4) {
356         _run_dijkstra(domain, AF_INET, false, true);
357       }
358       if (splitv6) {
359         _run_dijkstra(domain, AF_INET6, false, true);
360       }
361     }
362
363     /* check if direct one-hop routes are quicker */
364     _handle_nhdp_routes(domain);
365
366     /* update kernel routes */
367     _process_dijkstra_result(domain);
368   }
369
370   _process_kernel_queue();
371
372   /* make sure dijkstra is not called too often */
373   oonf_timer_set(&_rate_limit_timer, OLSRv2_DIJKSTRA_RATE_LIMITATION);
374 }
375
376 /**
377  * Initialize the dijkstra code part of a tc node.
378  * Should normally not be called by other parts of OLSRv2.
379  * @param dijkstra pointer to dijkstra node
380  */
381 void
382 olsrv2_routing_dijkstra_node_init(struct olsrv2_dijkstra_node *dijkstra,
383     const struct netaddr *originator) {
384   dijkstra->_node.key = &dijkstra->path_cost;
385   dijkstra->originator = originator;
386 }
387
388 /**
389  * Set the domain parameters of olsrv2
390  * @param domain pointer to NHDP domain
391  * @param parameter pointer to new parameters
392  */
393 void
394 olsrv2_routing_set_domain_parameter(struct nhdp_domain *domain,
395     struct olsrv2_routing_domain *parameter) {
396   struct olsrv2_routing_entry *rtentry;
397
398   if (memcmp(parameter, &_domain_parameter[domain->index],
399       sizeof(*parameter)) == 0) {
400     /* no change */
401     return;
402   }
403
404   /* copy parameters */
405   memcpy(&_domain_parameter[domain->index], parameter, sizeof(*parameter));
406
407   if (avl_is_empty(&_routing_tree[domain->index])) {
408     /* no routes present */
409     return;
410   }
411
412   /* remove old kernel routes */
413   avl_for_each_element(&_routing_tree[domain->index], rtentry, _node) {
414     if (rtentry->set) {
415       rtentry->set = false;
416
417       if (rtentry->in_processing) {
418         os_routing_interrupt(&rtentry->route);
419         rtentry->set = false;
420       }
421
422       _add_route_to_kernel_queue(rtentry);
423     }
424   }
425
426   _process_kernel_queue();
427
428   /* trigger a dijkstra to write new routes in 100 milliseconds */
429   oonf_timer_set(&_rate_limit_timer, 100);
430   _trigger_dijkstra = true;
431 }
432
433 /**
434  * Get tree of olsrv2 routing entries
435  * @param domain nhdp domain
436  * @return tree of routing entries
437  */
438 struct avl_tree *
439 olsrv2_routing_get_tree(struct nhdp_domain *domain) {
440   return &_routing_tree[domain->index];
441 }
442
443 /**
444  * Get list of olsrv2 routing filters
445  * @return filter list
446  */
447 struct list_entity *
448 olsrv2_routing_get_filter_list(void) {
449   return &_routing_filter_list;
450 }
451
452 /**
453  * Callback triggered when an MPR-set changed
454  * @param domain NHDP domain that changed
455  */
456 static void
457 _cb_mpr_update(struct nhdp_domain *domain) {
458   OONF_INFO(LOG_OLSRV2, "MPR update for domain %u", domain->index);
459
460   _update_ansn = true;
461   _domain_changed[domain->index] = true;
462   olsrv2_routing_trigger_update();
463 }
464
465 /**
466  * Callback triggered when an outgoing metric changed
467  * @param domain NHDP domain that changed
468  */
469 static void
470 _cb_metric_update(struct nhdp_domain *domain) {
471   OONF_INFO(LOG_OLSRV2, "Metric update for domain %u", domain->index);
472
473   _update_ansn = true;
474   _domain_changed[domain->index] = true;
475   olsrv2_routing_trigger_update();
476 }
477
478 /**
479  * Run Dijkstra for a set domain, address family and
480  * (non-)source-specific nodes
481  * @param domain nhdp domain
482  * @param af_family address family
483  * @param use_non_ss dijkstra should include non-source-specific ndoes
484  * @param use_ss dijkstra should include source-specific ndoes
485  */
486 static void
487 _run_dijkstra(struct nhdp_domain *domain, int af_family,
488     bool use_non_ss, bool use_ss) {
489   OONF_INFO(LOG_OLSRV2_ROUTING, "Run %s dijkstra on domain %d: %s/%s",
490       af_family == AF_INET ? "ipv4" : "ipv6", domain->index,
491       use_non_ss ? "true" : "false", use_ss ? "true" : "false");
492
493   /* add direct neighbors to working queue */
494   _add_one_hop_nodes(domain, af_family, use_non_ss, use_ss);
495
496   /* run dijkstra */
497   while (!avl_is_empty(&_dijkstra_working_tree)) {
498     _handle_working_queue(domain, use_non_ss, use_ss);
499   }
500 }
501
502 /**
503  * Add a new routing entry to the database
504  * @param domain pointer to nhdp domain
505  * @param prefix network prefix of routing entry
506  * @return pointer to routing entry, NULL if our of memory.
507  */
508 static struct olsrv2_routing_entry *
509 _add_entry(struct nhdp_domain *domain, struct os_route_key *prefix) {
510   struct olsrv2_routing_entry *rtentry;
511
512   rtentry = avl_find_element(
513       &_routing_tree[domain->index], prefix, rtentry, _node);
514   if (rtentry) {
515     return rtentry;
516   }
517
518   rtentry = oonf_class_malloc(&_rtset_entry);
519   if (rtentry == NULL) {
520     return NULL;
521   }
522
523   /* set key */
524   memcpy(&rtentry->route.p.key, prefix, sizeof(struct os_route_key));
525   rtentry->_node.key = &rtentry->route.p.key;
526
527   /* set domain */
528   rtentry->domain = domain;
529
530   /* initialize path costs and os-route callback */
531   rtentry->path_cost = RFC7181_METRIC_INFINITE_PATH;
532   rtentry->path_hops = 255;
533   rtentry->route.cb_finished = _cb_route_finished;
534   rtentry->route.p.family = netaddr_get_address_family(&prefix->dst);
535
536   rtentry->route.p.type = OS_ROUTE_UNICAST;
537
538   avl_insert(&_routing_tree[domain->index], &rtentry->_node);
539   return rtentry;
540 }
541
542 /**
543  * Remove a routing entry from the global database
544  * @param entry pointer to routing entry
545  */
546 static void
547 _remove_entry(struct olsrv2_routing_entry *entry) {
548   /* stop internal route processing */
549   entry->route.cb_finished = NULL;
550   os_routing_interrupt(&entry->route);
551
552   /* remove entry from database */
553   avl_remove(&_routing_tree[entry->domain->index], &entry->_node);
554   oonf_class_free(&_rtset_entry, entry);
555 }
556
557 /**
558  * Insert a new entry into the dijkstra working queue
559  * @param target pointer to tc target
560  * @param neigh next hop through which the target can be reached
561  * @param linkcost cost of the last hop of the path towards the target
562  * @param pathcost remainder of the cost to the target
563  * @param distance hopcount to be used for the route to the target
564  * @param single_hop true if this is a single-hop route, false otherwise
565  * @param last_node address of the last originator before we reached the
566  *   destination prefix
567  */
568 static void
569 _insert_into_working_tree(struct olsrv2_tc_target *target,
570     struct nhdp_neighbor *neigh, uint32_t linkcost,
571     uint32_t path_cost, uint8_t path_hops,
572     uint8_t distance, bool single_hop,
573     const struct netaddr *last_originator) {
574   struct olsrv2_dijkstra_node *node;
575 #ifdef OONF_LOG_DEBUG_INFO
576   struct netaddr_str nbuf1, nbuf2;
577 #endif
578   if (linkcost > RFC7181_METRIC_MAX) {
579     return;
580   }
581
582   node = &target->_dijkstra;
583
584   /*
585    * do not add ourselves to working queue,
586    * do not add nodes already processed to the working queue
587    */
588   if (node->local || node->done) {
589     return;
590   }
591
592   /* calculate new total pathcost */
593   path_cost += linkcost;
594   path_hops += 1;
595
596   if (avl_is_node_added(&node->_node)) {
597     /* node already in dijkstra working queue */
598
599     if (node->path_cost <= path_cost) {
600       /* current path is shorter than new one */
601       return;
602     }
603
604     /* we found a better path, remove node from working queue */
605     avl_remove(&_dijkstra_working_tree, &node->_node);
606   }
607   
608   OONF_DEBUG(LOG_OLSRV2_ROUTING, "Add dst %s [%s] with pathcost %u to dijstra tree (0x%zx)",
609           netaddr_to_string(&nbuf1, &target->prefix.dst),
610           netaddr_to_string(&nbuf2, &target->prefix.src), path_cost,
611           (size_t)target);
612
613   node->path_cost = path_cost;
614   node->path_hops = path_hops;
615   node->first_hop = neigh;
616   node->distance = distance;
617   node->single_hop = single_hop;
618   node->last_originator = last_originator;
619
620   avl_insert(&_dijkstra_working_tree, &node->_node);
621   return;
622 }
623
624 /**
625  * Initialize a routing entry with the result of the dijkstra calculation
626  * @param domain nhdp domain
627  * @param dst_prefix routing destination prefix
628  * @param dst_originator originator address of destination
629  * @param first_hop nhdp neighbor for first hop to target
630  * @param distance hopcount distance that should be used for route
631  * @param pathcost pathcost to target
632  * @param path_hops number of hops to the target
633  * @param single_hop true if route is single hop
634  * @param last_originator last originator before destination
635  */
636 static void
637 _update_routing_entry(struct nhdp_domain *domain,
638     struct os_route_key *dst_prefix, const struct netaddr *dst_originator,
639     struct nhdp_neighbor *first_hop,
640     uint8_t distance, uint32_t pathcost, uint8_t path_hops,
641     bool single_hop, const struct netaddr *last_originator) {
642   struct nhdp_neighbor_domaindata *neighdata;
643   struct olsrv2_routing_entry *rtentry;
644   const struct netaddr *originator;
645   struct olsrv2_lan_entry *lan;
646   struct olsrv2_lan_domaindata *landata;
647 #ifdef OONF_LOG_DEBUG_INFO
648   struct netaddr_str nbuf1, nbuf2, nbuf3;
649 #endif
650
651   /* test if destination is already part of the local node */
652   originator = olsrv2_originator_get(netaddr_get_address_family(&dst_prefix->dst));
653   if (netaddr_cmp(originator, &dst_prefix->dst) == 0) {
654     /* don't set routes for our own originator */
655     return;
656   }
657   if (nhdp_interface_addr_global_get(&dst_prefix->dst)) {
658     /* don't set routes for our own interface addresses */
659     return;
660   }
661   lan = olsrv2_lan_get(dst_prefix);
662   if (lan) {
663     landata = olsrv2_lan_get_domaindata(domain, lan);
664     if (landata->active && landata->outgoing_metric < pathcost) {
665       /*
666        * don't set routes for our own locally attached
667        * networks with a better metric
668        */
669       return;
670     }
671   }
672
673   if (!olsrv2_is_routable(&dst_prefix->dst)) {
674     /* don't set routes to non-routable destinations */
675     return;
676   }
677
678   /* make sure routing entry is present */
679   rtentry = _add_entry(domain, dst_prefix);
680   if (rtentry == NULL) {
681     /* out of memory... */
682     return;
683   }
684
685   /*
686    * routing entry might already be present because it can be set by
687    * a tc node AND by attached networks with a maximum prefix length
688    */
689   if (rtentry->set && rtentry->path_cost < pathcost) {
690     /* active routing entry is already cheaper, ignore new one */
691     return;
692   }
693
694   neighdata = nhdp_domain_get_neighbordata(domain, first_hop);
695   /* copy route parameters into data structure */
696   rtentry->route.p.if_index = neighdata->best_link_ifindex;
697   rtentry->path_cost = pathcost;
698   rtentry->path_hops = path_hops;
699   rtentry->route.p.metric = distance;
700
701   OONF_DEBUG(LOG_OLSRV2_ROUTING, "Initialize route entry dst %s [%s] (firsthop %s, domain %u) with pathcost %u, if %s",
702       netaddr_to_string(&nbuf1, &rtentry->route.p.key.dst),
703       netaddr_to_string(&nbuf2, &rtentry->route.p.key.src),
704       netaddr_to_string(&nbuf3, &first_hop->originator),
705       domain->ext, pathcost, neighdata->best_out_link->local_if->os_if_listener.data->name);
706
707   /* remember originator */
708   memcpy(&rtentry->originator, dst_originator, sizeof(struct netaddr));
709
710   /* remember next hop originator */
711   memcpy(&rtentry->next_originator, &first_hop->originator, sizeof(struct netaddr));
712
713   /* remember last originator */
714   memcpy(&rtentry->last_originator, last_originator, sizeof(*last_originator));
715
716   /* mark route as set */
717   rtentry->set = true;
718
719   /* copy gateway if necessary */
720   if (single_hop
721       && netaddr_cmp(&neighdata->best_out_link->if_addr,
722           &rtentry->route.p.key.dst) == 0) {
723     netaddr_invalidate(&rtentry->route.p.gw);
724   }
725   else {
726     memcpy(&rtentry->route.p.gw, &neighdata->best_out_link->if_addr,
727         sizeof(struct netaddr));
728   }
729 }
730
731 /**
732  * Initialize internal fields for dijkstra calculation
733  * @param domain nhdp domain
734  * @return true if source-specific and non-source specific can
735  *   be handled in the same dijkstra run, false otherwise
736  */
737 static void
738 _prepare_routes(struct nhdp_domain *domain) {
739   struct olsrv2_routing_entry *rtentry;
740   /* prepare all existing routing entries and put them into the working queue */
741   avl_for_each_element(&_routing_tree[domain->index], rtentry, _node) {
742     rtentry->set = false;
743     memcpy(&rtentry->_old, &rtentry->route.p, sizeof(rtentry->_old));
744   }
745 }
746
747 /**
748  * Initialize internal fields for dijkstra calculation
749  * @param domain nhdp domain
750  * @return true if source-specific and non-source specific can
751  *   be handled in the same dijkstra run, false otherwise
752  */
753 static void
754 _prepare_nodes(void) {
755   struct olsrv2_tc_endpoint *end;
756   struct olsrv2_tc_node *node;
757
758   /* initialize private dijkstra data on nodes */
759   avl_for_each_element(olsrv2_tc_get_tree(), node, _originator_node) {
760     node->target._dijkstra.first_hop = NULL;
761     node->target._dijkstra.path_cost = RFC7181_METRIC_INFINITE_PATH;
762     node->target._dijkstra.path_hops = 255;
763     node->target._dijkstra.local =
764         olsrv2_originator_is_local(&node->target.prefix.dst);
765     node->target._dijkstra.done = false;
766   }
767
768   /* initialize private dijkstra data on endpoints */
769   avl_for_each_element(olsrv2_tc_get_endpoint_tree(), end, _node) {
770     end->target._dijkstra.first_hop = NULL;
771     end->target._dijkstra.path_cost = RFC7181_METRIC_INFINITE_PATH;
772     end->target._dijkstra.path_hops = 255;
773     end->target._dijkstra.done = false;
774   }
775 }
776
777 /**
778  * calculates if source- and non-source-specific targets must be done
779  * in separate dijkstra runs
780  * @param domain nhdp domain for dijkstra run
781  * @param af_family address family for dijkstra run
782  * @return true if two dijkstra runs are necessary, false for one
783  */
784 static bool
785 _check_ssnode_split(struct nhdp_domain *domain, int af_family) {
786   struct olsrv2_tc_node *node;
787   uint32_t ssnode_count, full_count;
788   bool ssnode_prefix;
789
790   ssnode_count = 0;
791   full_count = 0;
792   ssnode_prefix = false;
793
794   avl_for_each_element(olsrv2_tc_get_tree(), node, _originator_node) {
795     /* count number of source specific nodes */
796     if (netaddr_get_address_family(&node->target.prefix.dst) == af_family) {
797       full_count++;
798       if (node->source_specific) {
799         ssnode_count++;
800       }
801     }
802
803     /* remember node domain with source specific prefix */
804     ssnode_prefix |= node->ss_attached_networks[domain->index];
805   }
806
807   OONF_INFO(LOG_OLSRV2_ROUTING, "ss split for %d/%d: %d of %d/%s",
808       domain->index, af_family, ssnode_count, full_count,
809       ssnode_prefix ? "true" : "false");
810
811   return ssnode_count != 0 && ssnode_count != full_count && ssnode_prefix;
812 }
813
814 /**
815  * Add the single-hop TC neighbors to the dijkstra working list
816  * @param domain nhdp domain for dijkstra run
817  * @param af_family address family for dijkstra run
818  * @param use_non_ss include non-source-specific nodes into working list
819  * @param use_ss include source-specific nodes into working list
820  */
821 static void
822 _add_one_hop_nodes(struct nhdp_domain *domain, int af_family,
823     bool use_non_ss, bool use_ss) {
824   struct olsrv2_tc_node *node;
825   struct nhdp_neighbor *neigh;
826   struct nhdp_neighbor_domaindata *neigh_metric;
827 #ifdef OONF_LOG_DEBUG_INFO
828   struct netaddr_str nbuf;
829 #endif
830
831   OONF_DEBUG(LOG_OLSRV2_ROUTING, "Start add one-hop nodes");
832
833   /* initialize Dijkstra working queue with one-hop neighbors */
834   list_for_each_element(nhdp_db_get_neigh_list(), neigh, _global_node) {
835     if (netaddr_get_address_family(&neigh->originator) != af_family) {
836       continue;
837     }
838
839     if (neigh->symmetric == 0
840         || (node = olsrv2_tc_node_get(&neigh->originator)) == NULL) {
841       continue;
842     }
843
844     if (!use_non_ss && !(node->source_specific && use_ss)) {
845       continue;
846     }
847
848     neigh_metric = nhdp_domain_get_neighbordata(domain, neigh);
849
850     if (neigh_metric->metric.in > RFC7181_METRIC_MAX
851         || neigh_metric->metric.out > RFC7181_METRIC_MAX) {
852       /* ignore link with infinite metric */
853       continue;
854     }
855
856     OONF_DEBUG(LOG_OLSRV2_ROUTING, "Add one-hop node %s",
857         netaddr_to_string(&nbuf, &neigh->originator));
858
859     /* found node for neighbor, add to worker list */
860     _insert_into_working_tree(&node->target, neigh,
861         neigh_metric->metric.out, 0, 0, 0, true,
862         olsrv2_originator_get(af_family));
863   }
864 }
865
866 /**
867  * Remove item from dijkstra working queue and process it
868  * @param domain nhdp domain
869  */
870 static void
871 _handle_working_queue(struct nhdp_domain *domain,
872     bool use_non_ss, bool use_ss) {
873   struct olsrv2_tc_target *target;
874   struct nhdp_neighbor *first_hop;
875   struct olsrv2_tc_node *tc_node;
876   struct olsrv2_tc_edge *tc_edge;
877   struct olsrv2_tc_attachment *tc_attached;
878   struct olsrv2_tc_endpoint *tc_endpoint;
879
880 #ifdef OONF_LOG_DEBUG_INFO
881   struct netaddr_str nbuf1, nbuf2;
882 #endif
883
884   /* get tc target */
885   target = avl_first_element(&_dijkstra_working_tree, target, _dijkstra._node);
886
887   /* remove current node from working tree */
888   OONF_DEBUG(LOG_OLSRV2_ROUTING, "Remove node %s [%s] from dijkstra tree",
889       netaddr_to_string(&nbuf1, &target->prefix.dst),
890       netaddr_to_string(&nbuf2, &target->prefix.src));
891   avl_remove(&_dijkstra_working_tree, &target->_dijkstra._node);
892
893   /* mark current node as done */
894   target->_dijkstra.done = true;
895
896   /* fill routing entry with dijkstra result */
897   if (use_non_ss) {
898     _update_routing_entry(domain, &target->prefix,
899         target->_dijkstra.originator,
900         target->_dijkstra.first_hop,
901         target->_dijkstra.distance,
902         target->_dijkstra.path_cost,
903         target->_dijkstra.path_hops,
904         target->_dijkstra.single_hop,
905         target->_dijkstra.last_originator);
906   }
907
908   if (target->type == OLSRV2_NODE_TARGET) {
909     /* get neighbor and its domain specific data */
910     first_hop = target->_dijkstra.first_hop;
911
912     /* calculate pointer of olsrv2_tc_node */
913     tc_node = container_of(target, struct olsrv2_tc_node, target);
914
915     /* iterate over edges */
916     avl_for_each_element(&tc_node->_edges, tc_edge, _node) {
917       if (!tc_edge->virtual && tc_edge->cost[domain->index] <= RFC7181_METRIC_MAX) {
918         if (!use_non_ss && !tc_node->source_specific) {
919           continue;
920         }
921
922         /* add new tc_node to working tree */
923         _insert_into_working_tree(&tc_edge->dst->target, first_hop,
924             tc_edge->cost[domain->index],
925             target->_dijkstra.path_cost, target->_dijkstra.path_hops,
926             0, false, &target->prefix.dst);
927       }
928     }
929
930     /* iterate over attached networks and addresses */
931     avl_for_each_element(&tc_node->_attached_networks, tc_attached, _src_node) {
932       if (tc_attached->cost[domain->index] <= RFC7181_METRIC_MAX) {
933         tc_endpoint = tc_attached->dst;
934
935         if (!(netaddr_get_prefix_length(&tc_endpoint->target.prefix.src) > 0
936             ? use_ss : use_non_ss)) {
937           /* filter out (non-)source-specific targets if necessary */
938           continue;
939         }
940         if (tc_endpoint->_attached_networks.count > 1) {
941           /* add attached network or address to working tree */
942           _insert_into_working_tree(&tc_attached->dst->target, first_hop,
943               tc_attached->cost[domain->index],
944               target->_dijkstra.path_cost, target->_dijkstra.path_hops,
945               tc_attached->distance[domain->index], false,
946               &target->prefix.dst);
947         }
948         else {
949           /* no other way to this endpoint */
950           tc_endpoint->target._dijkstra.done = true;
951
952           /* fill routing entry with dijkstra result */
953           _update_routing_entry(domain, &tc_endpoint->target.prefix,
954               &tc_node->target.prefix.dst,
955               first_hop, tc_attached->distance[domain->index],
956               target->_dijkstra.path_cost + tc_attached->cost[domain->index],
957               target->_dijkstra.path_hops + 1,
958               false, &target->prefix.dst);
959         }
960       }
961     }
962   }
963 }
964
965 /**
966  * Add routes learned from nhdp to dijkstra results
967  * @param domain nhdp domain
968  */
969 static void
970 _handle_nhdp_routes(struct nhdp_domain *domain) {
971   struct nhdp_neighbor_domaindata *neigh_data;
972   struct nhdp_neighbor *neigh;
973   struct nhdp_naddr *naddr;
974   struct nhdp_l2hop *l2hop;
975   struct nhdp_link *lnk;
976   const struct netaddr *originator;
977   uint32_t neighcost;
978   uint32_t l2hop_pathcost;
979   int family;
980   struct os_route_key ssprefix;
981
982   list_for_each_element(nhdp_db_get_neigh_list(), neigh, _global_node) {
983     family = netaddr_get_address_family(&neigh->originator);
984
985     /* get linkcost to neighbor */
986     neigh_data = nhdp_domain_get_neighbordata(domain, neigh);
987     neighcost = neigh_data->metric.out;
988
989     if (neigh->symmetric == 0 || neighcost > RFC7181_METRIC_MAX) {
990       continue;
991     }
992
993     /* make sure all addresses of the neighbor are better than our direct link */
994     avl_for_each_element(&neigh->_neigh_addresses, naddr, _neigh_node) {
995       if (!olsrv2_is_nhdp_routable(&naddr->neigh_addr)) {
996         /* not a routable address, check the next one */
997         continue;
998       }
999
1000       originator = olsrv2_originator_get(family);
1001       if (!originator) {
1002         originator = &NETADDR_UNSPEC;
1003       }
1004       os_routing_init_sourcespec_prefix(&ssprefix, &naddr->neigh_addr);
1005
1006       /* update routing entry */
1007       _update_routing_entry(domain, &ssprefix, originator,
1008           neigh, 0, neighcost, 1, true, originator);
1009     }
1010
1011     list_for_each_element(&neigh->_links, lnk, _neigh_node) {
1012       avl_for_each_element(&lnk->_2hop, l2hop, _link_node) {
1013         /* check if 2hop neighbor is lost */
1014         if (nhdp_db_2hop_is_lost(l2hop)) {
1015           continue;
1016         }
1017
1018         /* get new pathcost to 2hop neighbor */
1019         l2hop_pathcost = nhdp_domain_get_l2hopdata(domain, l2hop)->metric.out;
1020         if (l2hop_pathcost > RFC7181_METRIC_MAX) {
1021           continue;
1022         }
1023
1024         l2hop_pathcost += neighcost;
1025
1026         os_routing_init_sourcespec_prefix(&ssprefix, &l2hop->twohop_addr);
1027
1028         /* the 2-hop route is better than the dijkstra calculation */
1029         _update_routing_entry(domain, &ssprefix, &NETADDR_UNSPEC,
1030             neigh, 0, l2hop_pathcost, 2, false, &neigh->originator);
1031       }
1032     }
1033   }
1034 }
1035
1036 /**
1037  * Add a route to the kernel processing queue
1038  * @param rtentry pointer to routing entry
1039  */
1040 static void
1041 _add_route_to_kernel_queue(struct olsrv2_routing_entry *rtentry) {
1042 #ifdef OONF_LOG_INFO
1043   struct os_route_str rbuf1, rbuf2;
1044 #endif
1045
1046   if (rtentry->set) {
1047     OONF_INFO(LOG_OLSRV2_ROUTING,
1048         "Set route %s (%s)",
1049         os_routing_to_string(&rbuf1, &rtentry->route.p),
1050         os_routing_to_string(&rbuf2, &rtentry->_old));
1051
1052     if (netaddr_get_address_family(&rtentry->route.p.gw) == AF_UNSPEC) {
1053       /* insert/update single-hop routes early */
1054       list_add_head(&_kernel_queue, &rtentry->_working_node);
1055     }
1056     else {
1057       /* insert/update multi-hop routes late */
1058       list_add_tail(&_kernel_queue, &rtentry->_working_node);
1059     }
1060   }
1061   else {
1062     OONF_INFO(LOG_OLSRV2_ROUTING,
1063         "Dijkstra result: remove route %s",
1064         os_routing_to_string(&rbuf1, &rtentry->route.p));
1065
1066
1067     if (netaddr_get_address_family(&rtentry->route.p.gw) == AF_UNSPEC) {
1068       /* remove single-hop routes late */
1069       list_add_tail(&_kernel_queue, &rtentry->_working_node);
1070     }
1071     else {
1072       /* remove multi-hop routes early */
1073       list_add_head(&_kernel_queue, &rtentry->_working_node);
1074     }
1075   }
1076 }
1077
1078 /**
1079  * process the results of a dijkstra run and add them to the kernel
1080  * processing queue
1081  * @param domain nhdp domain
1082  */
1083 static void
1084 _process_dijkstra_result(struct nhdp_domain *domain) {
1085   struct olsrv2_routing_entry *rtentry;
1086   struct olsrv2_routing_filter *filter;
1087   struct olsrv2_lan_entry *lan_entry;
1088   struct olsrv2_lan_domaindata *lan_data;
1089
1090 #ifdef OONF_LOG_INFO
1091   struct os_route_str rbuf1, rbuf2;
1092 #endif
1093
1094   avl_for_each_element(&_routing_tree[domain->index], rtentry, _node) {
1095     /* initialize rest of route parameters */
1096     rtentry->route.p.table = _domain_parameter[rtentry->domain->index].table;
1097     rtentry->route.p.protocol = _domain_parameter[rtentry->domain->index].protocol;
1098     rtentry->route.p.metric = _domain_parameter[rtentry->domain->index].distance;
1099
1100     if (rtentry->set
1101         && _domain_parameter[rtentry->domain->index].use_srcip_in_routes
1102         && netaddr_get_address_family(&rtentry->route.p.key.dst) == AF_INET) {
1103       /* copy source address to route */
1104       memcpy(&rtentry->route.p.src_ip, olsrv2_originator_get(AF_INET),
1105           sizeof(rtentry->route.p.src_ip));
1106     }
1107
1108     lan_entry = olsrv2_lan_get(&rtentry->route.p.key);
1109     if (lan_entry) {
1110       lan_data = olsrv2_lan_get_domaindata(domain, lan_entry);
1111       if (lan_data->active && lan_data->outgoing_metric < rtentry->path_cost) {
1112         /* local prefix is BETTER than computed least const route ! */
1113         rtentry->set = false;
1114       }
1115     }
1116
1117     list_for_each_element(&_routing_filter_list, filter, _node) {
1118       if (!filter->filter(domain, &rtentry->route.p, rtentry->set)) {
1119         /* route modification was dropped by filter */
1120         continue;
1121       }
1122     }
1123
1124     if (rtentry->set
1125         && memcmp(&rtentry->_old, &rtentry->route.p, sizeof(rtentry->_old)) == 0) {
1126       /* no change, ignore this entry */
1127       OONF_INFO(LOG_OLSRV2_ROUTING,
1128           "Ignore route change: %s -> %s",
1129           os_routing_to_string(&rbuf1, &rtentry->_old),
1130           os_routing_to_string(&rbuf2, &rtentry->route.p));
1131       continue;
1132     }
1133     _add_route_to_kernel_queue(rtentry);
1134   }
1135 }
1136
1137 /**
1138  * Process all entries in kernel processing queue and send them to the kernel
1139  */
1140 static void
1141 _process_kernel_queue(void) {
1142   struct olsrv2_routing_entry *rtentry, *rt_it;
1143   struct os_route_str rbuf;
1144
1145   list_for_each_element_safe(&_kernel_queue, rtentry, _working_node, rt_it) {
1146     /* remove from routing queue */
1147     list_remove(&rtentry->_working_node);
1148
1149     if (rtentry->in_processing) {
1150       continue;
1151     }
1152
1153     /* mark route as in kernel processing */
1154     rtentry->in_processing = true;
1155
1156     if (rtentry->set) {
1157       /* add to kernel */
1158       if (os_routing_set(&rtentry->route, true, true)) {
1159         OONF_WARN(LOG_OLSRV2_ROUTING, "Could not set route %s",
1160             os_routing_to_string(&rbuf, &rtentry->route.p));
1161       }
1162     }
1163     else  {
1164       /* remove from kernel */
1165       if (os_routing_set(&rtentry->route, false, false)) {
1166         OONF_WARN(LOG_OLSRV2_ROUTING, "Could not remove route %s",
1167             os_routing_to_string(&rbuf, &rtentry->route.p));
1168       }
1169     }
1170   }
1171 }
1172
1173 /**
1174  * Callback for checking if dijkstra was triggered during
1175  * rate limitation time
1176  * @param ptr timer instance that fired
1177  */
1178 static void
1179 _cb_trigger_dijkstra(struct oonf_timer_instance *ptr __attribute__((unused))) {
1180   if (_trigger_dijkstra) {
1181     _trigger_dijkstra = false;
1182     olsrv2_routing_force_update(false);
1183   }
1184 }
1185
1186 /**
1187  * Callback for kernel route processing results
1188  * @param route pointer to kernel route
1189  * @param error 0 if no error happened
1190  */
1191 static void
1192 _cb_route_finished(struct os_route *route, int error) {
1193   struct olsrv2_routing_entry *rtentry;
1194   struct os_route_str rbuf;
1195
1196   rtentry = container_of(route, struct olsrv2_routing_entry, route);
1197
1198   /* kernel is not processing this route anymore */
1199   rtentry->in_processing = false;
1200
1201   if (!rtentry->set && error == ESRCH) {
1202     OONF_DEBUG(LOG_OLSRV2_ROUTING, "Route %s was already gone",
1203         os_routing_to_string(&rbuf, &rtentry->route.p));
1204   }
1205   else if (error) {
1206     if (error == -1) {
1207       /* someone called an interrupt */
1208       return;
1209     }
1210     /* an error happened, try again later */
1211     OONF_WARN(LOG_OLSRV2_ROUTING, "Error in route %s %s: %s (%d)",
1212         rtentry->set ? "setting" : "removal",
1213             os_routing_to_string(&rbuf, &rtentry->route.p),
1214             strerror(error), error);
1215
1216     if (error == EEXIST && rtentry->set) {
1217       /* exactly this route already exists */
1218       return;
1219     }
1220
1221     /* revert attempted change */
1222     if (rtentry->set) {
1223       _remove_entry(rtentry);
1224     }
1225     else {
1226       rtentry->set = true;
1227     }
1228     return;
1229   }
1230   if (rtentry->set) {
1231     /* route was set/updated successfully */
1232     OONF_INFO(LOG_OLSRV2_ROUTING, "Successfully set route %s",
1233         os_routing_to_string(&rbuf, &rtentry->route.p));
1234   }
1235   else {
1236     OONF_INFO(LOG_OLSRV2_ROUTING, "Successfully removed route %s",
1237         os_routing_to_string(&rbuf, &rtentry->route.p));
1238     _remove_entry(rtentry);
1239   }
1240 }