git.meshlink.io Git - meshlink/blob - src/graph.c

   1 /*
   2     graph.c -- graph algorithms
   3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /* We need to generate two trees from the graph:
  21
  22    1. A minimum spanning tree for broadcasts,
  23    2. A single-source shortest path tree for unicasts.
  24
  25    Actually, the first one alone would suffice but would make unicast packets
  26    take longer routes than necessary.
  27
  28    For the MST algorithm we can choose from Prim's or Kruskal's. I personally
  29    favour Kruskal's, because we make an extra AVL tree of edges sorted on
  30    weights (metric). That tree only has to be updated when an edge is added or
  31    removed, and during the MST algorithm we just have go linearly through that
  32    tree, adding safe edges until #edges = #nodes - 1. The implementation here
  33    however is not so fast, because I tried to avoid having to make a forest and
  34    merge trees.
  35
  36    For the SSSP algorithm Dijkstra's seems to be a nice choice. Currently a
  37    simple breadth-first search is presented here.
  38
  39    The SSSP algorithm will also be used to determine whether nodes are directly,
  40    indirectly or not reachable from the source. It will also set the correct
  41    destination address and port of a node if possible.
  42 */
  43
  44 #include "system.h"
  45
  46 #include "connection.h"
  47 #include "edge.h"
  48 #include "graph.h"
  49 #include "list.h"
  50 #include "logger.h"
  51 #include "meshlink_internal.h"
  52 #include "netutl.h"
  53 #include "node.h"
  54 #include "protocol.h"
  55 #include "utils.h"
  56 #include "xalloc.h"
  57 #include "graph.h"
  58
  59 /* Implementation of Kruskal's algorithm.
  60    Running time: O(EN)
  61    Please note that sorting on weight is already done by add_edge().
  62 */
  63
  64 static void mst_kruskal(meshlink_handle_t *mesh) {
  65         /* Clear MST status on connections */
  66
  67         for list_each(connection_t, c, mesh->connections) {
  68                 c->status.mst = false;
  69         }
  70
  71         logger(mesh, MESHLINK_DEBUG, "Running Kruskal's algorithm:");
  72
  73         /* Clear visited status on nodes */
  74
  75         for splay_each(node_t, n, mesh->nodes) {
  76                 n->status.visited = false;
  77         }
  78
  79         /* Starting point */
  80
  81         for splay_each(edge_t, e, mesh->edges) {
  82                 if(e->from->status.reachable) {
  83                         e->from->status.visited = true;
  84                         break;
  85                 }
  86         }
  87
  88         /* Add safe edges */
  89
  90         bool skipped = false;
  91
  92         for splay_each(edge_t, e, mesh->edges) {
  93                 if(!e->reverse || (e->from->status.visited == e->to->status.visited)) {
  94                         skipped = true;
  95                         continue;
  96                 }
  97
  98                 e->from->status.visited = true;
  99                 e->to->status.visited = true;
 100
 101                 if(e->connection) {
 102                         e->connection->status.mst = true;
 103                 }
 104
 105                 if(e->reverse->connection) {
 106                         e->reverse->connection->status.mst = true;
 107                 }
 108
 109                 logger(mesh, MESHLINK_DEBUG, " Adding edge %s - %s weight %d", e->from->name, e->to->name, e->weight);
 110
 111                 if(skipped) {
 112                         skipped = false;
 113                         next = mesh->edges->head;
 114                 }
 115         }
 116 }
 117
 118 /* Implementation of a simple breadth-first search algorithm.
 119    Running time: O(E)
 120 */
 121
 122 static void sssp_bfs(meshlink_handle_t *mesh) {
 123         list_t *todo_list = list_alloc(NULL);
 124
 125         /* Clear visited status on nodes */
 126
 127         for splay_each(node_t, n, mesh->nodes) {
 128                 n->status.visited = false;
 129                 n->status.indirect = true;
 130                 n->distance = -1;
 131         }
 132
 133         /* Begin with mesh->self */
 134
 135         mesh->self->status.visited = true;
 136         mesh->self->status.indirect = false;
 137         mesh->self->nexthop = mesh->self;
 138         mesh->self->prevedge = NULL;
 139         mesh->self->via = mesh->self;
 140         mesh->self->distance = 0;
 141         list_insert_head(todo_list, mesh->self);
 142
 143         /* Loop while todo_list is filled */
 144
 145         for list_each(node_t, n, todo_list) {                   /* "n" is the node from which we start */
 146                 logger(mesh, MESHLINK_DEBUG, " Examining edges from %s", n->name);
 147
 148                 if(n->distance < 0) {
 149                         abort();
 150                 }
 151
 152                 for splay_each(edge_t, e, n->edge_tree) {       /* "e" is the edge connected to "from" */
 153                         if(!e->reverse) {
 154                                 continue;
 155                         }
 156
 157                         /* Situation:
 158
 159                                    /
 160                                   /
 161                            ----->(n)---e-->(e->to)
 162                                   \
 163                                    \
 164
 165                            Where e is an edge, (n) and (e->to) are nodes.
 166                            n->address is set to the e->address of the edge left of n to n.
 167                            We are currently examining the edge e right of n from n:
 168
 169                            - If edge e provides for better reachability of e->to, update
 170                              e->to and (re)add it to the todo_list to (re)examine the reachability
 171                              of nodes behind it.
 172                          */
 173
 174                         bool indirect = n->status.indirect || e->options & OPTION_INDIRECT;
 175
 176                         if(e->to->status.visited
 177                                         && (!e->to->status.indirect || indirect)
 178                                         && (e->to->distance != n->distance + 1 || e->weight >= e->to->prevedge->weight)) {
 179                                 continue;
 180                         }
 181
 182                         e->to->status.visited = true;
 183                         e->to->status.indirect = indirect;
 184                         e->to->nexthop = (n->nexthop == mesh->self) ? e->to : n->nexthop;
 185                         e->to->prevedge = e;
 186                         e->to->via = indirect ? n->via : e->to;
 187                         e->to->options = e->options;
 188                         e->to->distance = n->distance + 1;
 189
 190                         if(!e->to->status.reachable || (e->to->address.sa.sa_family == AF_UNSPEC && e->address.sa.sa_family != AF_UNKNOWN)) {
 191                                 update_node_udp(mesh, e->to, &e->address);
 192                         }
 193
 194                         list_insert_tail(todo_list, e->to);
 195                 }
 196
 197                 next = node->next; /* Because the list_insert_tail() above could have added something extra for us! */
 198                 list_delete_node(todo_list, node);
 199         }
 200
 201         list_free(todo_list);
 202 }
 203
 204 static void check_reachability(meshlink_handle_t *mesh) {
 205         /* Check reachability status. */
 206
 207         for splay_each(node_t, n, mesh->nodes) {
 208                 if(n->status.visited != n->status.reachable) {
 209                         n->status.reachable = !n->status.reachable;
 210                         n->last_state_change = mesh->loop.now.tv_sec;
 211
 212                         if(n->status.reachable) {
 213                                 logger(mesh, MESHLINK_DEBUG, "Node %s became reachable", n->name);
 214                         } else {
 215                                 logger(mesh, MESHLINK_DEBUG, "Node %s became unreachable", n->name);
 216                         }
 217
 218                         /* TODO: only clear status.validkey if node is unreachable? */
 219
 220                         n->status.validkey = false;
 221                         sptps_stop(&n->sptps);
 222                         n->status.waitingforkey = false;
 223                         n->last_req_key = 0;
 224
 225                         n->status.udp_confirmed = false;
 226                         n->maxmtu = MTU;
 227                         n->minmtu = 0;
 228                         n->mtuprobes = 0;
 229
 230                         timeout_del(&mesh->loop, &n->mtutimeout);
 231
 232                         update_node_status(mesh, n);
 233
 234                         if(!n->status.reachable) {
 235                                 update_node_udp(mesh, n, NULL);
 236                                 n->status.broadcast = false;
 237                                 n->options = 0;
 238                         } else if(n->connection) {
 239                                 if(n->connection->outgoing) {
 240                                         send_req_key(mesh, n);
 241                                 }
 242                         }
 243                 }
 244         }
 245 }
 246
 247 void graph(meshlink_handle_t *mesh) {
 248         sssp_bfs(mesh);
 249         check_reachability(mesh);
 250         mst_kruskal(mesh);
 251 }