www.tinc-vpn.org Git - tinc/blob - src/graph.c

   1 /*
   2     graph.c -- graph algorithms
   3     Copyright (C) 2001-2002 Guus Sliepen <guus@sliepen.warande.net>,
   4                   2001-2002 Ivo Timmermans <itimmermans@bigfoot.com>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20     $Id: graph.c,v 1.4 2002/04/28 12:46:26 zarq Exp $
  21 */
  22
  23 /* We need to generate two trees from the graph:
  24
  25    1. A minimum spanning tree for broadcasts,
  26    2. A single-source shortest path tree for unicasts.
  27
  28    Actually, the first one alone would suffice but would make unicast packets
  29    take longer routes than necessary.
  30
  31    For the MST algorithm we can choose from Prim's or Kruskal's. I personally
  32    favour Kruskal's, because we make an extra AVL tree of edges sorted on
  33    weights (metric). That tree only has to be updated when an edge is added or
  34    removed, and during the MST algorithm we just have go linearly through that
  35    tree, adding safe edges until #edges = #nodes - 1. The implementation here
  36    however is not so fast, because I tried to avoid having to make a forest and
  37    merge trees.
  38
  39    For the SSSP algorithm Dijkstra's seems to be a nice choice. Currently a
  40    simple breadth-first search is presented here.
  41
  42    The SSSP algorithm will also be used to determine whether nodes are directly,
  43    indirectly or not reachable from the source. It will also set the correct
  44    destination address and port of a node if possible.
  45 */
  46
  47 #include "config.h"
  48
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51 #include <string.h>
  52 #if defined(HAVE_FREEBSD) || defined(HAVE_OPENBSD)
  53  #include <sys/param.h>
  54 #endif
  55 #include <netinet/in.h>
  56
  57 #include <avl_tree.h>
  58 #include <utils.h>
  59
  60 #include "netutl.h"
  61 #include "node.h"
  62 #include "edge.h"
  63 #include "connection.h"
  64 #include "process.h"
  65 #include "logging.h"
  66
  67 #include "system.h"
  68
  69 /* Implementation of Kruskal's algorithm.
  70    Running time: O(EN)
  71    Please note that sorting on weight is already done by add_edge().
  72 */
  73
  74 void mst_kruskal(void)
  75 {
  76   avl_node_t *node, *next;
  77   edge_t *e;
  78   node_t *n;
  79   connection_t *c;
  80   int nodes = 0;
  81   int safe_edges = 0;
  82   int skipped;
  83
  84   /* Clear MST status on connections */
  85
  86   for(node = connection_tree->head; node; node = node->next)
  87     {
  88       c = (connection_t *)node->data;
  89       c->status.mst = 0;
  90     }
  91
  92   /* Do we have something to do at all? */
  93
  94   if(!edge_weight_tree->head)
  95     return;
  96
  97   if(debug_lvl >= DEBUG_SCARY_THINGS)
  98     syslog(LOG_DEBUG, "Running Kruskal's algorithm:");
  99
 100   /* Clear visited status on nodes */
 101
 102   for(node = node_tree->head; node; node = node->next)
 103     {
 104       n = (node_t *)node->data;
 105       n->status.visited = 0;
 106       nodes++;
 107     }
 108
 109   /* Starting point */
 110
 111   ((edge_t *)edge_weight_tree->head->data)->from.node->status.visited = 1;
 112
 113   /* Add safe edges */
 114
 115   for(skipped = 0, node = edge_weight_tree->head; node; node = next)
 116     {
 117       next = node->next;
 118       e = (edge_t *)node->data;
 119
 120       if(e->from.node->status.visited == e->to.node->status.visited)
 121         {
 122           skipped = 1;
 123           continue;
 124         }
 125
 126       e->from.node->status.visited = 1;
 127       e->to.node->status.visited = 1;
 128       if(e->connection)
 129         e->connection->status.mst = 1;
 130
 131       safe_edges++;
 132
 133       if(debug_lvl >= DEBUG_SCARY_THINGS)
 134         syslog(LOG_DEBUG, " Adding edge %s - %s weight %d", e->from.node->name, e->to.node->name, e->weight);
 135
 136       if(skipped)
 137         {
 138           next = edge_weight_tree->head;
 139           continue;
 140         }
 141     }
 142
 143   if(debug_lvl >= DEBUG_SCARY_THINGS)
 144     syslog(LOG_DEBUG, "Done, counted %d nodes and %d safe edges.", nodes, safe_edges);
 145 }
 146
 147 /* Implementation of a simple breadth-first search algorithm.
 148    Running time: O(E)
 149 */
 150
 151 void sssp_bfs(void)
 152 {
 153   avl_node_t *node, *from, *next, *to;
 154   edge_t *e;
 155   node_t *n;
 156   halfconnection_t to_hc, from_hc;
 157   avl_tree_t *todo_tree;
 158   int indirect;
 159   char *name;
 160
 161   todo_tree = avl_alloc_tree(NULL, NULL);
 162
 163   /* Clear visited status on nodes */
 164
 165   for(node = node_tree->head; node; node = node->next)
 166     {
 167       n = (node_t *)node->data;
 168       n->status.visited = 0;
 169       n->status.indirect = 1;
 170     }
 171
 172   /* Begin with myself */
 173
 174   myself->status.visited = 1;
 175   myself->status.indirect = 0;
 176   myself->nexthop = myself;
 177   myself->via = myself;
 178   node = avl_alloc_node();
 179   node->data = myself;
 180   avl_insert_top(todo_tree, node);
 181
 182   /* Loop while todo_tree is filled */
 183
 184   while(todo_tree->head)
 185     {
 186       for(from = todo_tree->head; from; from = next)             /* "from" is the node from which we start */
 187         {
 188           next = from->next;
 189           n = (node_t *)from->data;
 190
 191           for(to = n->edge_tree->head; to; to = to->next)        /* "to" is the edge connected to "from" */
 192             {
 193               e = (edge_t *)to->data;
 194
 195               if(e->from.node == n)                              /* "from_hc" is the halfconnection with .node == from */
 196                 to_hc = e->to, from_hc = e->from;
 197               else
 198                 to_hc = e->from, from_hc = e->to;
 199
 200               /* Situation:
 201
 202                           /
 203                          /
 204                  ------(n)from_hc-----to_hc
 205                          \
 206                           \
 207
 208                  n->address is set to the to_hc.udpaddress of the edge left of n.
 209                  We are currently examining the edge right of n:
 210
 211                  - If from_hc.udpaddress != n->address, then to_hc.node is probably
 212                    not reachable for the nodes left of n. We do as if the indirectdata
 213                    flag is set on edge e.
 214                  - If edge e provides for better reachability of to_hc.node, update
 215                    to_hc.node and (re)add it to the todo_tree to (re)examine the reachability
 216                    of nodes behind it.
 217               */
 218
 219               indirect = n->status.indirect || e->options & OPTION_INDIRECT || ((n != myself) && sockaddrcmp(&n->address, &from_hc.udpaddress));
 220
 221               if(to_hc.node->status.visited && (!to_hc.node->status.indirect || indirect))
 222                 continue;
 223
 224               to_hc.node->status.visited = 1;
 225               to_hc.node->status.indirect = indirect;
 226               to_hc.node->nexthop = (n->nexthop == myself) ? to_hc.node : n->nexthop;
 227               to_hc.node->via = indirect ? n->via : to_hc.node;
 228               to_hc.node->options = e->options;
 229               if(sockaddrcmp(&to_hc.node->address, &to_hc.udpaddress))
 230               {
 231                 node = avl_unlink(node_udp_tree, to_hc.node);
 232                 to_hc.node->address = to_hc.udpaddress;
 233                 if(to_hc.node->hostname)
 234                   free(to_hc.node->hostname);
 235                 to_hc.node->hostname = sockaddr2hostname(&to_hc.udpaddress);
 236                 avl_insert_node(node_udp_tree, node);
 237               }
 238               node = avl_alloc_node();
 239               node->data = to_hc.node;
 240               avl_insert_before(todo_tree, from, node);
 241             }
 242
 243           avl_delete_node(todo_tree, from);
 244         }
 245     }
 246
 247   avl_free_tree(todo_tree);
 248
 249   /* Check reachability status. */
 250
 251   for(node = node_tree->head; node; node = next)
 252     {
 253       next = node->next;
 254       n = (node_t *)node->data;
 255
 256       if(n->status.visited)
 257       {
 258         if(!n->status.reachable)
 259         {
 260           if(debug_lvl >= DEBUG_TRAFFIC)
 261             syslog(LOG_DEBUG, _("Node %s (%s) became reachable"), n->name, n->hostname);
 262           n->status.reachable = 1;
 263           asprintf(&name, "hosts/%s-up", n->name);
 264           execute_script(name);
 265           free(name);
 266         }
 267       }
 268       else
 269       {
 270         if(n->status.reachable)
 271         {
 272           if(debug_lvl >= DEBUG_TRAFFIC)
 273             syslog(LOG_DEBUG, _("Node %s (%s) became unreachable"), n->name, n->hostname);
 274           n->status.reachable = 0;
 275           n->status.validkey = 0;
 276           n->status.waitingforkey = 0;
 277           n->sent_seqno = 0;
 278           asprintf(&name, "hosts/%s-down", n->name);
 279           execute_script(name);
 280           free(name);
 281         }
 282       }
 283     }
 284 }
 285
 286 void graph(void)
 287 {
 288   mst_kruskal();
 289   sssp_bfs();
 290 }