Use conditional compilation for device.c.
[tinc] / src / graph.c
index 7b8880d..302056a 100644 (file)
@@ -1,7 +1,7 @@
 /*
     graph.c -- graph algorithms
-    Copyright (C) 2001 Guus Sliepen <guus@sliepen.warande.net>,
-                  2001 Ivo Timmermans <itimmermans@bigfoot.com>
+    Copyright (C) 2001-2013 Guus Sliepen <guus@tinc-vpn.org>,
+                  2001-2005 Ivo Timmermans
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-    $Id: graph.c,v 1.1.2.3 2001/10/29 13:14:57 guus Exp $
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
 /* We need to generate two trees from the graph:
    favour Kruskal's, because we make an extra AVL tree of edges sorted on
    weights (metric). That tree only has to be updated when an edge is added or
    removed, and during the MST algorithm we just have go linearly through that
-   tree, adding safe edges until #edges = #nodes - 1.
+   tree, adding safe edges until #edges = #nodes - 1. The implementation here
+   however is not so fast, because I tried to avoid having to make a forest and
+   merge trees.
 
    For the SSSP algorithm Dijkstra's seems to be a nice choice. Currently a
    simple breadth-first search is presented here.
-*/
 
-#include <syslog.h>
-#include "config.h"
-#include <string.h>
+   The SSSP algorithm will also be used to determine whether nodes are directly,
+   indirectly or not reachable from the source. It will also set the correct
+   destination address and port of a node if possible.
+*/
 
-#include <avl_tree.h>
+#include "system.h"
 
-#include "node.h"
-#include "edge.h"
 #include "connection.h"
-
-#include "system.h"
+#include "device.h"
+#include "edge.h"
+#include "graph.h"
+#include "list.h"
+#include "logger.h"
+#include "names.h"
+#include "netutl.h"
+#include "node.h"
+#include "process.h"
+#include "protocol.h"
+#include "subnet.h"
+#include "utils.h"
+#include "xalloc.h"
+#include "graph.h"
 
 /* Implementation of Kruskal's algorithm.
    Running time: O(EN)
    Please note that sorting on weight is already done by add_edge().
 */
 
-void mst_kruskal(void)
-{
-  avl_node_t *node;
-  edge_t *e;
-  node_t *n;
-  connection_t *c;
-  int nodes = 0;
-  int safe_edges = 0;
-  int skipped;
-
-  syslog(LOG_DEBUG, _("Running Kruskal's algorithm:"));
-
-  /* Clear visited status on nodes */
+static void mst_kruskal(void) {
+       /* Clear MST status on connections */
 
-  for(node = node_tree->head; node; node = node->next)
-    {
-      n = (node_t *)node->data;
-      n->status.visited = 0;
-      nodes++;
-    }
+       for list_each(connection_t, c, connection_list)
+               c->status.mst = false;
 
-  /* Starting point */
-  
-  ((edge_t *)edge_weight_tree->head->data)->from->status.visited = 1;
+       logger(DEBUG_SCARY_THINGS, LOG_DEBUG, "Running Kruskal's algorithm:");
 
-  /* Clear MST status on connections */
+       /* Clear visited status on nodes */
 
-  for(node = connection_tree->head; node; node = node->next)
-    {
-      c = (connection_t *)node->data;
-      c->status.mst = 0;
-    }
+       for splay_each(node_t, n, node_tree)
+               n->status.visited = false;
 
-  /* Add safe edges */
+       /* Starting point */
 
-  while(safe_edges < nodes - 1)
-  for(skipped = 0, node = edge_weight_tree->head; node; node = node->next)
-    {
-// Algorithm should work without this:
-//      if(safe_edges = nodes - 1)
-//        break;
+       for splay_each(edge_t, e, edge_weight_tree) {
+               if(e->from->status.reachable) {
+                       e->from->status.visited = true;
+                       break;
+               }
+       }
 
-      e = (edge_t *)node->data;
+       /* Add safe edges */
 
-      if(e->from->status.visited == e->to->status.visited)
-        {
-          skipped = 1;
-          continue;
-        }
+       bool skipped = false;
 
-      e->from->status.visited = 1;
-      e->to->status.visited = 1;
-      if(e->connection)
-        e->connection->status.mst = 1;
+       for splay_each(edge_t, e, edge_weight_tree) {
+               if(!e->reverse || (e->from->status.visited == e->to->status.visited)) {
+                       skipped = true;
+                       continue;
+               }
 
-      safe_edges++;
+               e->from->status.visited = true;
+               e->to->status.visited = true;
 
-      syslog(LOG_DEBUG, _("Adding safe edge %s - %s weight %d"), e->from->name, e->to->name, e->weight);
+               if(e->connection)
+                       e->connection->status.mst = true;
 
-      if(skipped)
-        break;
-    }
+               if(e->reverse->connection)
+                       e->reverse->connection->status.mst = true;
 
-  syslog(LOG_DEBUG, _("Done."));
+               logger(DEBUG_SCARY_THINGS, LOG_DEBUG, " Adding edge %s - %s weight %d", e->from->name, e->to->name, e->weight);
 
-  if(safe_edges != nodes - 1)
-    {
-      syslog(LOG_ERR, _("Implementation of Kruskal's algorithm is screwed: %d nodes, found %d safe edges"), nodes, safe_edges);
-    }
+               if(skipped) {
+                       skipped = false;
+                       next = edge_weight_tree->head;
+               }
+       }
 }
 
 /* Implementation of a simple breadth-first search algorithm.
    Running time: O(E)
 */
 
-void sssp_bfs(void)
-{
-  avl_node_t *node, *from, *next, *to;
-  edge_t *e;
-  node_t *n, *check;
-  int nodes = 0;
-  int visited = 0;
-  avl_tree_t *todo_tree;
-
-  syslog(LOG_DEBUG, _("Running BFS algorithm:"));
-
-  todo_tree = avl_alloc_tree(NULL, NULL);
-
-  /* Clear visited status on nodes */
-
-  for(node = node_tree->head; node; node = node->next)
-    {
-      n = (node_t *)node->data;
-      n->status.visited = 0;
-      nodes++;
-    }
-
-  /* Begin with myself */
-
-  myself->status.visited = 1;
-  myself->nexthop = myself;
-  myself->via = myself;
-  node = avl_alloc_node();
-  node->data = myself;
-  avl_insert_top(todo_tree, node);
-  visited++;
-
-  /* Loop while todo_tree is filled */
-
-  while(todo_tree->head)
-    {
-      for(from = todo_tree->head; from; from = next)
-        {
-          next = from->next;
-          n = (node_t *)from->data;
-
-          for(to = n->edge_tree->head; to; to = to->next)
-            {
-              e = (edge_t *)to->data;
-
-              if(e->from == n)
-                check = e->to;
-              else
-                check = e->from;
-
-              if(!check->status.visited)
-                {
-                  check->status.visited = 1;
-                  check->nexthop = (n->nexthop == myself) ? n : n->nexthop;
-                  check->via = check; /* FIXME: only if !(e->options & INDIRECT), otherwise use n->via */
-                  node = avl_alloc_node();
-                  node->data = check;
-                  avl_insert_before(todo_tree, from, node);
-                  visited++;
-                  syslog(LOG_DEBUG, _("Node %s nexthop %s via %s"), check->name, check->nexthop->name, check->via->name);
-                }
-            }
-
-           avl_delete_node(todo_tree, from);
-        }
-    }
-
-  syslog(LOG_DEBUG, _("Done."));
-
-  avl_free_tree(todo_tree);
-
-  if(visited != nodes)
-    {
-      syslog(LOG_ERR, _("Implementation of BFS algorithm is screwed: %d nodes, visited %d"), nodes, visited);
-    }
+static void sssp_bfs(void) {
+       list_t *todo_list = list_alloc(NULL);
+
+       /* Clear visited status on nodes */
+
+       for splay_each(node_t, n, node_tree) {
+               n->status.visited = false;
+               n->status.indirect = true;
+               n->distance = -1;
+       }
+
+       /* Begin with myself */
+
+       myself->status.visited = true;
+       myself->status.indirect = false;
+       myself->nexthop = myself;
+       myself->prevedge = NULL;
+       myself->via = myself;
+       myself->distance = 0;
+       list_insert_head(todo_list, myself);
+
+       /* Loop while todo_list is filled */
+
+       for list_each(node_t, n, todo_list) {                   /* "n" is the node from which we start */
+               logger(DEBUG_SCARY_THINGS, LOG_DEBUG, " Examining edges from %s", n->name);
+
+               if(n->distance < 0)
+                       abort();
+
+               for splay_each(edge_t, e, n->edge_tree) {       /* "e" is the edge connected to "from" */
+                       if(!e->reverse)
+                               continue;
+
+                       /* Situation:
+
+                                  /
+                                 /
+                          ----->(n)---e-->(e->to)
+                                 \
+                                  \
+
+                          Where e is an edge, (n) and (e->to) are nodes.
+                          n->address is set to the e->address of the edge left of n to n.
+                          We are currently examining the edge e right of n from n:
+
+                          - If edge e provides for better reachability of e->to, update
+                            e->to and (re)add it to the todo_list to (re)examine the reachability
+                            of nodes behind it.
+                        */
+
+                       bool indirect = n->status.indirect || e->options & OPTION_INDIRECT;
+
+                       if(e->to->status.visited
+                          && (!e->to->status.indirect || indirect)
+                          && (e->to->distance != n->distance + 1 || e->weight >= e->to->prevedge->weight))
+                               continue;
+
+                       e->to->status.visited = true;
+                       e->to->status.indirect = indirect;
+                       e->to->nexthop = (n->nexthop == myself) ? e->to : n->nexthop;
+                       e->to->prevedge = e;
+                       e->to->via = indirect ? n->via : e->to;
+                       e->to->options = e->options;
+                       e->to->distance = n->distance + 1;
+
+                       if(!e->to->status.reachable || (e->to->address.sa.sa_family == AF_UNSPEC && e->address.sa.sa_family != AF_UNKNOWN))
+                               update_node_udp(e->to, &e->address);
+
+                       list_insert_tail(todo_list, e->to);
+               }
+
+               next = node->next; /* Because the list_insert_tail() above could have added something extra for us! */
+               list_delete_node(todo_list, node);
+       }
+
+       list_free(todo_list);
+}
+
+static void check_reachability(void) {
+       /* Check reachability status. */
+
+       for splay_each(node_t, n, node_tree) {
+               if(n->status.visited != n->status.reachable) {
+                       n->status.reachable = !n->status.reachable;
+                       n->last_state_change = now.tv_sec;
+
+                       if(n->status.reachable) {
+                               logger(DEBUG_TRAFFIC, LOG_DEBUG, "Node %s (%s) became reachable",
+                                          n->name, n->hostname);
+                       } else {
+                               logger(DEBUG_TRAFFIC, LOG_DEBUG, "Node %s (%s) became unreachable",
+                                          n->name, n->hostname);
+                       }
+
+                       if(experimental && OPTION_VERSION(n->options) >= 2)
+                               n->status.sptps = true;
+
+                       /* TODO: only clear status.validkey if node is unreachable? */
+
+                       n->status.validkey = false;
+                       if(n->status.sptps) {
+                               sptps_stop(&n->sptps);
+                               n->status.waitingforkey = false;
+                       }
+                       n->last_req_key = 0;
+
+                       n->status.udp_confirmed = false;
+                       n->maxmtu = MTU;
+                       n->minmtu = 0;
+                       n->mtuprobes = 0;
+
+                       timeout_del(&n->mtutimeout);
+
+                       char *name;
+                       char *address;
+                       char *port;
+                       char *envp[7];
+
+                       xasprintf(&envp[0], "NETNAME=%s", netname ? : "");
+                       xasprintf(&envp[1], "DEVICE=%s", device ? : "");
+                       xasprintf(&envp[2], "INTERFACE=%s", iface ? : "");
+                       xasprintf(&envp[3], "NODE=%s", n->name);
+                       sockaddr2str(&n->address, &address, &port);
+                       xasprintf(&envp[4], "REMOTEADDRESS=%s", address);
+                       xasprintf(&envp[5], "REMOTEPORT=%s", port);
+                       envp[6] = NULL;
+
+                       execute_script(n->status.reachable ? "host-up" : "host-down", envp);
+
+                       xasprintf(&name, n->status.reachable ? "hosts/%s-up" : "hosts/%s-down", n->name);
+                       execute_script(name, envp);
+
+                       free(name);
+                       free(address);
+                       free(port);
+
+                       for(int i = 0; i < 6; i++)
+                               free(envp[i]);
+
+                       subnet_update(n, NULL, n->status.reachable);
+
+                       if(!n->status.reachable) {
+                               update_node_udp(n, NULL);
+                               memset(&n->status, 0, sizeof n->status);
+                               n->options = 0;
+                       } else if(n->connection) {
+                               if(n->status.sptps) {
+                                       if(n->connection->outgoing)
+                                               send_req_key(n);
+                               } else {
+                                       send_ans_key(n);
+                               }
+                       }
+               }
+       }
+}
+
+void graph(void) {
+       subnet_cache_flush();
+       sssp_bfs();
+       check_reachability();
+       mst_kruskal();
 }