- Non-blocking connect()s.
[tinc] / 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.1.2.7 2002/02/18 16:25:16 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 <syslog.h>
48 #include "config.h"
49 #include <string.h>
50 #if defined(HAVE_FREEBSD) || defined(HAVE_OPENBSD)
51  #include <sys/param.h>
52 #endif
53 #include <netinet/in.h>
54
55 #include <avl_tree.h>
56 #include <utils.h>
57
58 #include "netutl.h"
59 #include "node.h"
60 #include "edge.h"
61 #include "connection.h"
62
63 #include "system.h"
64
65 /* Implementation of Kruskal's algorithm.
66    Running time: O(EN)
67    Please note that sorting on weight is already done by add_edge().
68 */
69
70 void mst_kruskal(void)
71 {
72   avl_node_t *node, *next;
73   edge_t *e;
74   node_t *n;
75   connection_t *c;
76   int nodes = 0;
77   int safe_edges = 0;
78   int skipped;
79
80   /* Do we have something to do at all? */
81   
82   if(!edge_weight_tree->head)
83     return;
84
85   /* Clear visited status on nodes */
86
87   for(node = node_tree->head; node; node = node->next)
88     {
89       n = (node_t *)node->data;
90       n->status.visited = 0;
91       nodes++;
92     }
93
94   /* Starting point */
95   
96   ((edge_t *)edge_weight_tree->head->data)->from.node->status.visited = 1;
97
98   /* Clear MST status on connections */
99
100   for(node = connection_tree->head; node; node = node->next)
101     {
102       c = (connection_t *)node->data;
103       c->status.mst = 0;
104     }
105
106   /* Add safe edges */
107
108   for(skipped = 0, node = edge_weight_tree->head; node; node = next)
109     {
110       next = node->next;
111       e = (edge_t *)node->data;
112
113       if(e->from.node->status.visited == e->to.node->status.visited)
114         {
115           skipped = 1;
116           continue;
117         }
118
119       e->from.node->status.visited = 1;
120       e->to.node->status.visited = 1;
121       if(e->connection)
122         e->connection->status.mst = 1;
123
124       safe_edges++;
125
126       if(skipped)
127         {
128           next = edge_weight_tree->head;
129           continue;
130         }
131     }
132 }
133
134 /* Implementation of a simple breadth-first search algorithm.
135    Running time: O(E)
136 */
137
138 void sssp_bfs(void)
139 {
140   avl_node_t *node, *from, *next, *to;
141   edge_t *e;
142   node_t *n;
143   halfconnection_t to_hc, from_hc;
144   avl_tree_t *todo_tree;
145
146   todo_tree = avl_alloc_tree(NULL, NULL);
147
148   /* Clear visited status on nodes */
149
150   for(node = node_tree->head; node; node = node->next)
151     {
152       n = (node_t *)node->data;
153       n->status.visited = 0;
154     }
155
156   /* Begin with myself */
157
158   myself->status.visited = 1;
159   myself->nexthop = myself;
160   myself->via = myself;
161   node = avl_alloc_node();
162   node->data = myself;
163   avl_insert_top(todo_tree, node);
164
165   /* Loop while todo_tree is filled */
166
167   while(todo_tree->head)
168     {
169       for(from = todo_tree->head; from; from = next)             /* "from" is the node from which we start */
170         {
171           next = from->next;
172           n = (node_t *)from->data;
173
174           for(to = n->edge_tree->head; to; to = to->next)        /* "to" is the edge connected to "from" */
175             {
176               e = (edge_t *)to->data;
177
178               if(e->from.node == n)                              /* "from_hc" is the halfconnection with .node == from */
179                 to_hc = e->to, from_hc = e->from;
180               else
181                 to_hc = e->from, from_hc = e->to;
182
183               if(!to_hc.node->status.visited)
184                 {
185                   to_hc.node->status.visited = 1;
186                   to_hc.node->nexthop = (n->nexthop == myself) ? to_hc.node : n->nexthop;
187                   to_hc.node->via = (e->options & OPTION_INDIRECT || n->via != n) ? n->via : to_hc.node;
188                   to_hc.node->options = e->options;
189                   if(sockaddrcmp(&to_hc.node->address, &to_hc.udpaddress))
190                   {
191                     node = avl_unlink(node_udp_tree, to_hc.node);
192                     to_hc.node->address = to_hc.udpaddress;
193                     if(to_hc.node->hostname)
194                       free(to_hc.node->hostname);
195                     to_hc.node->hostname = sockaddr2hostname(&to_hc.udpaddress);
196                     avl_insert_node(node_udp_tree, node);
197                   }
198                   node = avl_alloc_node();
199                   node->data = to_hc.node;
200                   avl_insert_before(todo_tree, from, node);
201                 }
202             }
203
204           avl_delete_node(todo_tree, from);
205         }
206     }
207
208   avl_free_tree(todo_tree);
209   
210   /* Check reachability status. */
211
212   for(node = node_tree->head; node; node = next)
213     {
214       next = node->next;
215       n = (node_t *)node->data;
216
217       if(n->status.visited)
218       {
219         if(!n->status.reachable)
220         {
221           if(debug_lvl >= DEBUG_TRAFFIC)
222             syslog(LOG_DEBUG, _("Node %s (%s) became reachable"), n->name, n->hostname);
223           n->status.reachable = 1;
224         }
225       }
226       else
227       {
228         if(n->status.reachable)
229         {
230           if(debug_lvl >= DEBUG_TRAFFIC)
231             syslog(LOG_DEBUG, _("Node %s (%s) became unreachable"), n->name, n->hostname);
232           n->status.reachable = 0;
233           n->status.validkey = 0;
234           n->status.waitingforkey = 0;
235           n->sent_seqno = 0;
236         }
237       }
238     }
239 }
240
241 void graph(void)
242 {
243   mst_kruskal();
244   sssp_bfs();
245 }