6841ff29ae874bd7a9ae40323016d1e7bb02eb31
[tinc] / src / graph.c
1 /*
2     graph.c -- graph algorithms
3     Copyright (C) 2001-2002 Guus Sliepen <guus@sliepen.eu.org>,
4                   2001-2002 Ivo Timmermans <ivo@o2w.nl>
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.1.2.16 2002/09/06 09:48:39 guus 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 <syslog.h>
51 #include "config.h"
52 #include <string.h>
53 #ifdef HAVE_SYS_PARAM_H
54  #include <sys/param.h>
55 #endif
56 #include <netinet/in.h>
57
58 #include <avl_tree.h>
59 #include <utils.h>
60
61 #include "netutl.h"
62 #include "node.h"
63 #include "edge.h"
64 #include "connection.h"
65 #include "process.h"
66 #include "device.h"
67
68 #include "system.h"
69
70 /* Implementation of Kruskal's algorithm.
71    Running time: O(EN)
72    Please note that sorting on weight is already done by add_edge().
73 */
74
75 void mst_kruskal(void)
76 {
77   avl_node_t *node, *next;
78   edge_t *e;
79   node_t *n;
80   connection_t *c;
81   int nodes = 0;
82   int safe_edges = 0;
83   int skipped;
84
85   /* Clear MST status on connections */
86
87   for(node = connection_tree->head; node; node = node->next)
88     {
89       c = (connection_t *)node->data;
90       c->status.mst = 0;
91     }
92
93   /* Do we have something to do at all? */
94   
95   if(!edge_weight_tree->head)
96     return;
97
98   if(debug_lvl >= DEBUG_SCARY_THINGS)
99     syslog(LOG_DEBUG, "Running Kruskal's algorithm:");
100
101   /* Clear visited status on nodes */
102
103   for(node = node_tree->head; node; node = node->next)
104     {
105       n = (node_t *)node->data;
106       n->status.visited = 0;
107       nodes++;
108     }
109
110   /* Starting point */
111   
112   ((edge_t *)edge_weight_tree->head->data)->from->status.visited = 1;
113
114   /* Add safe edges */
115
116   for(skipped = 0, node = edge_weight_tree->head; node; node = next)
117     {
118       next = node->next;
119       e = (edge_t *)node->data;
120
121       if(!e->reverse || e->from->status.visited == e->to->status.visited)
122         {
123           skipped = 1;
124           continue;
125         }
126
127       e->from->status.visited = 1;
128       e->to->status.visited = 1;
129       if(e->connection)
130         e->connection->status.mst = 1;
131
132       safe_edges++;
133
134       if(debug_lvl >= DEBUG_SCARY_THINGS)
135         syslog(LOG_DEBUG, " Adding edge %s - %s weight %d", e->from->name, e->to->name, e->weight);
136
137       if(skipped)
138         {
139           skipped = 0;
140           next = edge_weight_tree->head;
141           continue;
142         }
143     }
144
145   if(debug_lvl >= DEBUG_SCARY_THINGS)
146     syslog(LOG_DEBUG, "Done, counted %d nodes and %d safe edges.", nodes, safe_edges);
147 }
148
149 /* Implementation of a simple breadth-first search algorithm.
150    Running time: O(E)
151 */
152
153 void sssp_bfs(void)
154 {
155   avl_node_t *node, *from, *next, *to;
156   edge_t *e;
157   node_t *n;
158   avl_tree_t *todo_tree;
159   int indirect;
160   char *name;
161   char *address, *port;
162   char *envp[7];
163   int i;
164
165   todo_tree = avl_alloc_tree(NULL, NULL);
166
167   /* Clear visited status on nodes */
168
169   for(node = node_tree->head; node; node = node->next)
170     {
171       n = (node_t *)node->data;
172       n->status.visited = 0;
173       n->status.indirect = 1;
174     }
175
176   /* Begin with myself */
177
178   myself->status.visited = 1;
179   myself->status.indirect = 0;
180   myself->nexthop = myself;
181   myself->via = myself;
182   node = avl_alloc_node();
183   node->data = myself;
184   avl_insert_top(todo_tree, node);
185
186   /* Loop while todo_tree is filled */
187
188   while(todo_tree->head)
189     {
190       for(from = todo_tree->head; from; from = next)             /* "from" is the node from which we start */
191         {
192           next = from->next;
193           n = (node_t *)from->data;
194
195           for(to = n->edge_tree->head; to; to = to->next)        /* "to" is the edge connected to "from" */
196             {
197               e = (edge_t *)to->data;
198               
199               if(!e->reverse)
200                 continue;
201
202               /* Situation:
203
204                           /
205                          /
206                  ------(n)-----(e->to)
207                          \
208                           \
209
210                  n->address is set to the e->address of the edge left of n to n.
211                  We are currently examining the edge e right of n from n:
212
213                  - If e->reverse->address != n->address, then e->to is probably
214                    not reachable for the nodes left of n. We do as if the indirectdata
215                    flag is set on edge e.
216                  - If edge e provides for better reachability of e->to, update
217                    e->to and (re)add it to the todo_tree to (re)examine the reachability
218                    of nodes behind it.
219               */
220
221               indirect = n->status.indirect || e->options & OPTION_INDIRECT || ((n != myself) && sockaddrcmp(&n->address, &e->reverse->address));
222
223               if(e->to->status.visited && (!e->to->status.indirect || indirect))
224                 continue;
225
226               e->to->status.visited = 1;
227               e->to->status.indirect = indirect;
228               e->to->nexthop = (n->nexthop == myself) ? e->to : n->nexthop;
229               e->to->via = indirect ? n->via : e->to;
230               e->to->options = e->options;
231               if(sockaddrcmp(&e->to->address, &e->address))
232                 {
233                   node = avl_unlink(node_udp_tree, e->to);
234                   e->to->address = e->address;
235                   if(e->to->hostname)
236                     free(e->to->hostname);
237                   e->to->hostname = sockaddr2hostname(&e->to->address);
238                   avl_insert_node(node_udp_tree, node);
239                 }
240               node = avl_alloc_node();
241               node->data = e->to;
242               avl_insert_before(todo_tree, from, node);
243             }
244
245           avl_delete_node(todo_tree, from);
246         }
247     }
248
249   avl_free_tree(todo_tree);
250   
251   /* Check reachability status. */
252
253   for(node = node_tree->head; node; node = next)
254     {
255       next = node->next;
256       n = (node_t *)node->data;
257
258       if(n->status.visited != n->status.reachable)
259       {
260         n->status.reachable = !n->status.reachable;
261         if(debug_lvl >= DEBUG_TRAFFIC)
262           if(n->status.reachable)
263             syslog(LOG_DEBUG, _("Node %s (%s) became reachable"), n->name, n->hostname);
264           else
265             syslog(LOG_DEBUG, _("Node %s (%s) became unreachable"), n->name, n->hostname);
266
267         n->status.validkey = 0;
268         n->status.waitingforkey = 0;
269
270         asprintf(&envp[0], "NETNAME=%s", netname?netname:"");
271         asprintf(&envp[1], "DEVICE=%s", device?device:"");
272         asprintf(&envp[2], "INTERFACE=%s", interface?interface:"");
273         asprintf(&envp[3], "NODE=%s", n->name);
274         sockaddr2str(&n->address, &address, &port);
275         asprintf(&envp[4], "REMOTEADDRESS=%s", address);
276         asprintf(&envp[5], "REMOTEPORT=%s", port);
277         envp[6] = NULL;
278
279         asprintf(&name, n->status.reachable?"hosts/%s-up":"hosts/%s-down", n->name);
280         execute_script(name, envp);
281         free(name);
282         free(address);
283         free(port);
284
285         for(i = 0; i < 7; i++)
286           free(envp[i]);
287       }
288     }
289 }
290
291 void graph(void)
292 {
293   mst_kruskal();
294   sssp_bfs();
295 }